<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>py2ecotect.app.application</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="py2ecotect-module.html">Package&nbsp;py2ecotect</a> ::
        <a href="py2ecotect.app-module.html">Package&nbsp;app</a> ::
        Module&nbsp;application
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="py2ecotect.app.application-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="py2ecotect.app.application-module.html">Module py2ecotect.app.application</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno">   1</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt id="link-0" class="py-name" targets="Package py2ecotect=py2ecotect-module.html"><a title="py2ecotect" class="py-name" href="#" onclick="return doclink('link-0', 'py2ecotect', 'link-0');">py2ecotect</a></tt> <tt class="py-keyword">as</tt> <tt class="py-name">p2e</tt> </tt>
<a name="L2"></a><tt class="py-lineno">   2</tt>  <tt class="py-line"> </tt>
<a name="L3"></a><tt class="py-lineno">   3</tt>  <tt class="py-line"><tt class="py-comment">#===========================================================================</tt> </tt>
<a name="L4"></a><tt class="py-lineno">   4</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Functions</tt> </tt>
<a name="L5"></a><tt class="py-lineno">   5</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#===========================================================================</tt> </tt>
<a name="activate"></a><div id="activate-def"><a name="L6"></a><tt class="py-lineno">   6</tt> <a class="py-toggle" href="#" id="activate-toggle" onclick="return toggle('activate');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#activate">activate</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="activate-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="activate-expanded"><a name="L7"></a><tt class="py-lineno">   7</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L8"></a><tt class="py-lineno">   8</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L9"></a><tt class="py-lineno">   9</tt>  <tt class="py-line"><tt class="py-docstring">    Displays the main ECOTECT window and brings it to the front if it is </tt> </tt>
<a name="L10"></a><tt class="py-lineno">  10</tt>  <tt class="py-line"><tt class="py-docstring">    behind any other windows.</tt> </tt>
<a name="L11"></a><tt class="py-lineno">  11</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L12"></a><tt class="py-lineno">  12</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L13"></a><tt class="py-lineno">  13</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this command.</tt> </tt>
<a name="L14"></a><tt class="py-lineno">  14</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L15"></a><tt class="py-lineno">  15</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L16"></a><tt class="py-lineno">  16</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Variable py2ecotect._app=py2ecotect-module.html#_app"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-1', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-string">"app.activate"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L17"></a><tt class="py-lineno">  17</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="alert"></a><div id="alert-def"><a name="L18"></a><tt class="py-lineno">  18</tt> <a class="py-toggle" href="#" id="alert-toggle" onclick="return toggle('alert');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#alert">alert</a><tt class="py-op">(</tt><tt class="py-param">msg</tt><tt class="py-op">,</tt> <tt class="py-param">type</tt> <tt class="py-op">=</tt> <tt class="py-string">""</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="alert-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="alert-expanded"><a name="L19"></a><tt class="py-lineno">  19</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L20"></a><tt class="py-lineno">  20</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L21"></a><tt class="py-lineno">  21</tt>  <tt class="py-line"><tt class="py-docstring">    Displays a popup message box displaying the given message and an OK </tt> </tt>
<a name="L22"></a><tt class="py-lineno">  22</tt>  <tt class="py-line"><tt class="py-docstring">    button. You can change the different icons and titles displayed in the </tt> </tt>
<a name="L23"></a><tt class="py-lineno">  23</tt>  <tt class="py-line"><tt class="py-docstring">    dialog using the info, question, warning or error suffixes.</tt> </tt>
<a name="L24"></a><tt class="py-lineno">  24</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L25"></a><tt class="py-lineno">  25</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L26"></a><tt class="py-lineno">  26</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L27"></a><tt class="py-lineno">  27</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L28"></a><tt class="py-lineno">  28</tt>  <tt class="py-line"><tt class="py-docstring">    type</tt> </tt>
<a name="L29"></a><tt class="py-lineno">  29</tt>  <tt class="py-line"><tt class="py-docstring">    If you want an alert dialog, enter "". Otherwise enter info, question, </tt> </tt>
<a name="L30"></a><tt class="py-lineno">  30</tt>  <tt class="py-line"><tt class="py-docstring">    warning or error</tt> </tt>
<a name="L31"></a><tt class="py-lineno">  31</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L32"></a><tt class="py-lineno">  32</tt>  <tt class="py-line"><tt class="py-docstring">    msg </tt> </tt>
<a name="L33"></a><tt class="py-lineno">  33</tt>  <tt class="py-line"><tt class="py-docstring">    A string containing the message to be displayed.</tt> </tt>
<a name="L34"></a><tt class="py-lineno">  34</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L35"></a><tt class="py-lineno">  35</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L36"></a><tt class="py-lineno">  36</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-2" class="py-name" targets="Module py2ecotect._util=py2ecotect._util-module.html"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-2', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-3" class="py-name" targets="Function py2ecotect._util._convert_args_to_string()=py2ecotect._util-module.html#_convert_args_to_string"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-3', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"app.alert."</tt> <tt class="py-op">+</tt> <tt id="link-4" class="py-name" targets="Variable py2ecotect.app.movie.Movie.type=py2ecotect.app.movie.Movie-class.html#type"><a title="py2ecotect.app.movie.Movie.type" class="py-name" href="#" onclick="return doclink('link-4', 'type', 'link-4');">type</a></tt><tt class="py-op">,</tt> <tt class="py-name">msg</tt><tt class="py-op">)</tt> </tt>
<a name="L37"></a><tt class="py-lineno">  37</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-5" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-5', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L38"></a><tt class="py-lineno">  38</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="busy"></a><div id="busy-def"><a name="L39"></a><tt class="py-lineno">  39</tt> <a class="py-toggle" href="#" id="busy-toggle" onclick="return toggle('busy');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#busy">busy</a><tt class="py-op">(</tt><tt class="py-param">action</tt><tt class="py-op">,</tt> <tt class="py-param">message</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="busy-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="busy-expanded"><a name="L40"></a><tt class="py-lineno">  40</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L41"></a><tt class="py-lineno">  41</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L42"></a><tt class="py-lineno">  42</tt>  <tt class="py-line"><tt class="py-docstring">    Controls the display of the 'Application Busy' dialog box. Use this </tt> </tt>
<a name="L43"></a><tt class="py-lineno">  43</tt>  <tt class="py-line"><tt class="py-docstring">    dialog during a complex calculation whose progress is not linear or </tt> </tt>
<a name="L44"></a><tt class="py-lineno">  44</tt>  <tt class="py-line"><tt class="py-docstring">    unsuitable for using the standard progress bar. </tt> </tt>
<a name="L45"></a><tt class="py-lineno">  45</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L46"></a><tt class="py-lineno">  46</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L47"></a><tt class="py-lineno">  47</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L48"></a><tt class="py-lineno">  48</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L49"></a><tt class="py-lineno">  49</tt>  <tt class="py-line"><tt class="py-docstring">    action </tt> </tt>
<a name="L50"></a><tt class="py-lineno">  50</tt>  <tt class="py-line"><tt class="py-docstring">    This first parameter gives the required action. The open action opens </tt> </tt>
<a name="L51"></a><tt class="py-lineno">  51</tt>  <tt class="py-line"><tt class="py-docstring">    the dialog box and displays the static message provided. The update </tt> </tt>
<a name="L52"></a><tt class="py-lineno">  52</tt>  <tt class="py-line"><tt class="py-docstring">    action refreshes the dynamic message line displayed immediately beneath </tt> </tt>
<a name="L53"></a><tt class="py-lineno">  53</tt>  <tt class="py-line"><tt class="py-docstring">    the static message and is used to keep the user informed of progress. </tt> </tt>
<a name="L54"></a><tt class="py-lineno">  54</tt>  <tt class="py-line"><tt class="py-docstring">    The close action closes and hides the busy dialog. </tt> </tt>
<a name="L55"></a><tt class="py-lineno">  55</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L56"></a><tt class="py-lineno">  56</tt>  <tt class="py-line"><tt class="py-docstring">    message </tt> </tt>
<a name="L57"></a><tt class="py-lineno">  57</tt>  <tt class="py-line"><tt class="py-docstring">    This parameter provides the message to be displayed within the busy </tt> </tt>
<a name="L58"></a><tt class="py-lineno">  58</tt>  <tt class="py-line"><tt class="py-docstring">    dialog. When used with the open action, the message becomes the static </tt> </tt>
<a name="L59"></a><tt class="py-lineno">  59</tt>  <tt class="py-line"><tt class="py-docstring">    title displayed in bold in the centre. When used with the update action, </tt> </tt>
<a name="L60"></a><tt class="py-lineno">  60</tt>  <tt class="py-line"><tt class="py-docstring">    this parameters is used as the dynamic message line displayed </tt> </tt>
<a name="L61"></a><tt class="py-lineno">  61</tt>  <tt class="py-line"><tt class="py-docstring">    immediately beneath the static message. This parameter is ignored when </tt> </tt>
<a name="L62"></a><tt class="py-lineno">  62</tt>  <tt class="py-line"><tt class="py-docstring">    using the close action. </tt> </tt>
<a name="L63"></a><tt class="py-lineno">  63</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L64"></a><tt class="py-lineno">  64</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L65"></a><tt class="py-lineno">  65</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-6" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-6', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-7" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-7', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"app.busy"</tt> <tt class="py-op">+</tt> <tt id="link-8" class="py-name" targets="Variable py2ecotect.app.radiance.Radiance.action=py2ecotect.app.radiance.Radiance-class.html#action"><a title="py2ecotect.app.radiance.Radiance.action" class="py-name" href="#" onclick="return doclink('link-8', 'action', 'link-8');">action</a></tt><tt class="py-op">,</tt>  </tt>
<a name="L66"></a><tt class="py-lineno">  66</tt>  <tt class="py-line">                                                  <tt class="py-name">message</tt><tt class="py-op">)</tt> </tt>
<a name="L67"></a><tt class="py-lineno">  67</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-9', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L68"></a><tt class="py-lineno">  68</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="center"></a><div id="center-def"><a name="L69"></a><tt class="py-lineno">  69</tt> <a class="py-toggle" href="#" id="center-toggle" onclick="return toggle('center');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#center">center</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="center-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="center-expanded"><a name="L70"></a><tt class="py-lineno">  70</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L71"></a><tt class="py-lineno">  71</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L72"></a><tt class="py-lineno">  72</tt>  <tt class="py-line"><tt class="py-docstring">    Use this command to centre the main Ecotect window withing the current </tt> </tt>
<a name="L73"></a><tt class="py-lineno">  73</tt>  <tt class="py-line"><tt class="py-docstring">    desktop. Its size will remain the same, it will simply move into the </tt> </tt>
<a name="L74"></a><tt class="py-lineno">  74</tt>  <tt class="py-line"><tt class="py-docstring">    centre of the screen. </tt> </tt>
<a name="L75"></a><tt class="py-lineno">  75</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L76"></a><tt class="py-lineno">  76</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L77"></a><tt class="py-lineno">  77</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this command.</tt> </tt>
<a name="L78"></a><tt class="py-lineno">  78</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L79"></a><tt class="py-lineno">  79</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L80"></a><tt class="py-lineno">  80</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-10" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-10', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-string">"app.center"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L81"></a><tt class="py-lineno">  81</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="character"></a><div id="character-def"><a name="L82"></a><tt class="py-lineno">  82</tt> <a class="py-toggle" href="#" id="character-toggle" onclick="return toggle('character');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#character">character</a><tt class="py-op">(</tt><tt class="py-param">text</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="character-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="character-expanded"><a name="L83"></a><tt class="py-lineno">  83</tt>  <tt class="py-line">    <tt class="py-docstring">"""   </tt> </tt>
<a name="L84"></a><tt class="py-lineno">  84</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L85"></a><tt class="py-lineno">  85</tt>  <tt class="py-line"><tt class="py-docstring">    Use this command to send a stream of characters to the currently focused </tt> </tt>
<a name="L86"></a><tt class="py-lineno">  86</tt>  <tt class="py-line"><tt class="py-docstring">    control. The text parameter is simply a string of characters. </tt> </tt>
<a name="L87"></a><tt class="py-lineno">  87</tt>  <tt class="py-line"><tt class="py-docstring">    Note: this is very experimental and will need to be used in conjunction </tt> </tt>
<a name="L88"></a><tt class="py-lineno">  88</tt>  <tt class="py-line"><tt class="py-docstring">    with the app.mouseevent or app.keyevent commands to first select the </tt> </tt>
<a name="L89"></a><tt class="py-lineno">  89</tt>  <tt class="py-line"><tt class="py-docstring">    required control. </tt> </tt>
<a name="L90"></a><tt class="py-lineno">  90</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L91"></a><tt class="py-lineno">  91</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L92"></a><tt class="py-lineno">  92</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L93"></a><tt class="py-lineno">  93</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L94"></a><tt class="py-lineno">  94</tt>  <tt class="py-line"><tt class="py-docstring">    text </tt> </tt>
<a name="L95"></a><tt class="py-lineno">  95</tt>  <tt class="py-line"><tt class="py-docstring">    A string of characters that are to be 'typed' or sent to the currently </tt> </tt>
<a name="L96"></a><tt class="py-lineno">  96</tt>  <tt class="py-line"><tt class="py-docstring">    selected control. </tt> </tt>
<a name="L97"></a><tt class="py-lineno">  97</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L98"></a><tt class="py-lineno">  98</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L99"></a><tt class="py-lineno">  99</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-11" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-11', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-12" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-12', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"app.character"</tt><tt class="py-op">,</tt> <tt class="py-name">text</tt><tt class="py-op">)</tt> </tt>
<a name="L100"></a><tt class="py-lineno"> 100</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-13" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-13', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L101"></a><tt class="py-lineno"> 101</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="exit"></a><div id="exit-def"><a name="L102"></a><tt class="py-lineno"> 102</tt> <a class="py-toggle" href="#" id="exit-toggle" onclick="return toggle('exit');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#exit">exit</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="exit-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="exit-expanded"><a name="L103"></a><tt class="py-lineno"> 103</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L104"></a><tt class="py-lineno"> 104</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L105"></a><tt class="py-lineno"> 105</tt>  <tt class="py-line"><tt class="py-docstring">    This function causes the instance of Ecotect running the script to exit, </tt> </tt>
<a name="L106"></a><tt class="py-lineno"> 106</tt>  <tt class="py-line"><tt class="py-docstring">    just as if you had manualy chosen the &gt; Exit menu item. You will need to </tt> </tt>
<a name="L107"></a><tt class="py-lineno"> 107</tt>  <tt class="py-line"><tt class="py-docstring">    be careful using this command as it may automatically save any changes </tt> </tt>
<a name="L108"></a><tt class="py-lineno"> 108</tt>  <tt class="py-line"><tt class="py-docstring">    you have made to the current model unless you use the model.new function </tt> </tt>
<a name="L109"></a><tt class="py-lineno"> 109</tt>  <tt class="py-line"><tt class="py-docstring">    first.</tt> </tt>
<a name="L110"></a><tt class="py-lineno"> 110</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L111"></a><tt class="py-lineno"> 111</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L112"></a><tt class="py-lineno"> 112</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this command.</tt> </tt>
<a name="L113"></a><tt class="py-lineno"> 113</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L114"></a><tt class="py-lineno"> 114</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L115"></a><tt class="py-lineno"> 115</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-14" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-14', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-string">"app.exit"</tt><tt class="py-op">)</tt> </tt>
</div><a name="L116"></a><tt class="py-lineno"> 116</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="key"></a><div id="key-def"><a name="L117"></a><tt class="py-lineno"> 117</tt> <a class="py-toggle" href="#" id="key-toggle" onclick="return toggle('key');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#key">key</a><tt class="py-op">(</tt><tt class="py-param">keyCode</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="key-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="key-expanded"><a name="L118"></a><tt class="py-lineno"> 118</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L119"></a><tt class="py-lineno"> 119</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L120"></a><tt class="py-lineno"> 120</tt>  <tt class="py-line"><tt class="py-docstring">    Use this command to emulate virtual keyboard events in the currently </tt> </tt>
<a name="L121"></a><tt class="py-lineno"> 121</tt>  <tt class="py-line"><tt class="py-docstring">    active window or control. With this command you can simulate TAB and </tt> </tt>
<a name="L122"></a><tt class="py-lineno"> 122</tt>  <tt class="py-line"><tt class="py-docstring">    control keys. The key parameter is the virtual key code of the key to be </tt> </tt>
<a name="L123"></a><tt class="py-lineno"> 123</tt>  <tt class="py-line"><tt class="py-docstring">    pressed, as given in the following table.</tt> </tt>
<a name="L124"></a><tt class="py-lineno"> 124</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L125"></a><tt class="py-lineno"> 125</tt>  <tt class="py-line"><tt class="py-docstring">    Important Note: Keyboard events are generated directly using the </tt> </tt>
<a name="L126"></a><tt class="py-lineno"> 126</tt>  <tt class="py-line"><tt class="py-docstring">    keyboard interrupt, which are then sent to the target application via </tt> </tt>
<a name="L127"></a><tt class="py-lineno"> 127</tt>  <tt class="py-line"><tt class="py-docstring">    the Windows message queue. Thus, you must give the program time to </tt> </tt>
<a name="L128"></a><tt class="py-lineno"> 128</tt>  <tt class="py-line"><tt class="py-docstring">    complete any tasks that may result from each keystroke. If not, the </tt> </tt>
<a name="L129"></a><tt class="py-lineno"> 129</tt>  <tt class="py-line"><tt class="py-docstring">    application may miss the next command and hang the script, meaning that </tt> </tt>
<a name="L130"></a><tt class="py-lineno"> 130</tt>  <tt class="py-line"><tt class="py-docstring">    you will have to disconnect/reconnect.</tt> </tt>
<a name="L131"></a><tt class="py-lineno"> 131</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L132"></a><tt class="py-lineno"> 132</tt>  <tt class="py-line"><tt class="py-docstring">    To overcome this, use the Script Manager pause(msec) command immediately </tt> </tt>
<a name="L133"></a><tt class="py-lineno"> 133</tt>  <tt class="py-line"><tt class="py-docstring">    after such a keystroke or slow down the execution speed of the script </tt> </tt>
<a name="L134"></a><tt class="py-lineno"> 134</tt>  <tt class="py-line"><tt class="py-docstring">    using the script("delay 1000"); command immediately prior to the </tt> </tt>
<a name="L135"></a><tt class="py-lineno"> 135</tt>  <tt class="py-line"><tt class="py-docstring">    keystroke. </tt> </tt>
<a name="L136"></a><tt class="py-lineno"> 136</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L137"></a><tt class="py-lineno"> 137</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L138"></a><tt class="py-lineno"> 138</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L139"></a><tt class="py-lineno"> 139</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L140"></a><tt class="py-lineno"> 140</tt>  <tt class="py-line"><tt class="py-docstring">    keyCode </tt> </tt>
<a name="L141"></a><tt class="py-lineno"> 141</tt>  <tt class="py-line"><tt class="py-docstring">    A value specifying the key code to emulate. Some example values are </tt> </tt>
<a name="L142"></a><tt class="py-lineno"> 142</tt>  <tt class="py-line"><tt class="py-docstring">    given in the following table. </tt> </tt>
<a name="L143"></a><tt class="py-lineno"> 143</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L144"></a><tt class="py-lineno"> 144</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L145"></a><tt class="py-lineno"> 145</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L146"></a><tt class="py-lineno"> 146</tt>  <tt class="py-line"><tt class="py-docstring">    Virtual Key Codes </tt> </tt>
<a name="L147"></a><tt class="py-lineno"> 147</tt>  <tt class="py-line"><tt class="py-docstring">    Key Code Value</tt> </tt>
<a name="L148"></a><tt class="py-lineno"> 148</tt>  <tt class="py-line"><tt class="py-docstring">    VK_CANCEL 3  </tt> </tt>
<a name="L149"></a><tt class="py-lineno"> 149</tt>  <tt class="py-line"><tt class="py-docstring">    VK_PRINT 42 </tt> </tt>
<a name="L150"></a><tt class="py-lineno"> 150</tt>  <tt class="py-line"><tt class="py-docstring">    VK_BACK 8  </tt> </tt>
<a name="L151"></a><tt class="py-lineno"> 151</tt>  <tt class="py-line"><tt class="py-docstring">    VK_EXECUTE 43 </tt> </tt>
<a name="L152"></a><tt class="py-lineno"> 152</tt>  <tt class="py-line"><tt class="py-docstring">    VK_TAB 9  </tt> </tt>
<a name="L153"></a><tt class="py-lineno"> 153</tt>  <tt class="py-line"><tt class="py-docstring">    VK_SNAPSHOT 44 </tt> </tt>
<a name="L154"></a><tt class="py-lineno"> 154</tt>  <tt class="py-line"><tt class="py-docstring">    VK_CLEAR 12  </tt> </tt>
<a name="L155"></a><tt class="py-lineno"> 155</tt>  <tt class="py-line"><tt class="py-docstring">    VK_INSERT 45 </tt> </tt>
<a name="L156"></a><tt class="py-lineno"> 156</tt>  <tt class="py-line"><tt class="py-docstring">    VK_RETURN 13  </tt> </tt>
<a name="L157"></a><tt class="py-lineno"> 157</tt>  <tt class="py-line"><tt class="py-docstring">    VK_DELETE 46 </tt> </tt>
<a name="L158"></a><tt class="py-lineno"> 158</tt>  <tt class="py-line"><tt class="py-docstring">    VK_SHIFT 16  </tt> </tt>
<a name="L159"></a><tt class="py-lineno"> 159</tt>  <tt class="py-line"><tt class="py-docstring">    VK_HELP 47 </tt> </tt>
<a name="L160"></a><tt class="py-lineno"> 160</tt>  <tt class="py-line"><tt class="py-docstring">    VK_CONTROL 17  </tt> </tt>
<a name="L161"></a><tt class="py-lineno"> 161</tt>  <tt class="py-line"><tt class="py-docstring">    VK_SLEEP 95 </tt> </tt>
<a name="L162"></a><tt class="py-lineno"> 162</tt>  <tt class="py-line"><tt class="py-docstring">    VK_MENU 18  </tt> </tt>
<a name="L163"></a><tt class="py-lineno"> 163</tt>  <tt class="py-line"><tt class="py-docstring">    VK_F1 112 </tt> </tt>
<a name="L164"></a><tt class="py-lineno"> 164</tt>  <tt class="py-line"><tt class="py-docstring">    VK_PAUSE 19  </tt> </tt>
<a name="L165"></a><tt class="py-lineno"> 165</tt>  <tt class="py-line"><tt class="py-docstring">    VK_F2 113 </tt> </tt>
<a name="L166"></a><tt class="py-lineno"> 166</tt>  <tt class="py-line"><tt class="py-docstring">    VK_CAPITAL 20  </tt> </tt>
<a name="L167"></a><tt class="py-lineno"> 167</tt>  <tt class="py-line"><tt class="py-docstring">    VK_F3 114 </tt> </tt>
<a name="L168"></a><tt class="py-lineno"> 168</tt>  <tt class="py-line"><tt class="py-docstring">    VK_ESCAPE 27  </tt> </tt>
<a name="L169"></a><tt class="py-lineno"> 169</tt>  <tt class="py-line"><tt class="py-docstring">    VK_F4 115 </tt> </tt>
<a name="L170"></a><tt class="py-lineno"> 170</tt>  <tt class="py-line"><tt class="py-docstring">    VK_SPACE 32  </tt> </tt>
<a name="L171"></a><tt class="py-lineno"> 171</tt>  <tt class="py-line"><tt class="py-docstring">    VK_F5 116 </tt> </tt>
<a name="L172"></a><tt class="py-lineno"> 172</tt>  <tt class="py-line"><tt class="py-docstring">    VK_PRIOR 33  </tt> </tt>
<a name="L173"></a><tt class="py-lineno"> 173</tt>  <tt class="py-line"><tt class="py-docstring">    VK_F6 117 </tt> </tt>
<a name="L174"></a><tt class="py-lineno"> 174</tt>  <tt class="py-line"><tt class="py-docstring">    VK_NEXT 34  </tt> </tt>
<a name="L175"></a><tt class="py-lineno"> 175</tt>  <tt class="py-line"><tt class="py-docstring">    VK_F7 118 </tt> </tt>
<a name="L176"></a><tt class="py-lineno"> 176</tt>  <tt class="py-line"><tt class="py-docstring">    VK_END 35  </tt> </tt>
<a name="L177"></a><tt class="py-lineno"> 177</tt>  <tt class="py-line"><tt class="py-docstring">    VK_F8 119 </tt> </tt>
<a name="L178"></a><tt class="py-lineno"> 178</tt>  <tt class="py-line"><tt class="py-docstring">    VK_HOME 36  </tt> </tt>
<a name="L179"></a><tt class="py-lineno"> 179</tt>  <tt class="py-line"><tt class="py-docstring">    VK_F9 120 </tt> </tt>
<a name="L180"></a><tt class="py-lineno"> 180</tt>  <tt class="py-line"><tt class="py-docstring">    VK_LEFT 37  </tt> </tt>
<a name="L181"></a><tt class="py-lineno"> 181</tt>  <tt class="py-line"><tt class="py-docstring">    VK_F10 121 </tt> </tt>
<a name="L182"></a><tt class="py-lineno"> 182</tt>  <tt class="py-line"><tt class="py-docstring">    VK_UP 38  </tt> </tt>
<a name="L183"></a><tt class="py-lineno"> 183</tt>  <tt class="py-line"><tt class="py-docstring">    VK_F11 122 </tt> </tt>
<a name="L184"></a><tt class="py-lineno"> 184</tt>  <tt class="py-line"><tt class="py-docstring">    VK_RIGHT 39  </tt> </tt>
<a name="L185"></a><tt class="py-lineno"> 185</tt>  <tt class="py-line"><tt class="py-docstring">    VK_F12 123 </tt> </tt>
<a name="L186"></a><tt class="py-lineno"> 186</tt>  <tt class="py-line"><tt class="py-docstring">    VK_DOWN 40  </tt> </tt>
<a name="L187"></a><tt class="py-lineno"> 187</tt>  <tt class="py-line"><tt class="py-docstring">    VK_NUMLOCK 144 </tt> </tt>
<a name="L188"></a><tt class="py-lineno"> 188</tt>  <tt class="py-line"><tt class="py-docstring">    VK_SELECT 41  </tt> </tt>
<a name="L189"></a><tt class="py-lineno"> 189</tt>  <tt class="py-line"><tt class="py-docstring">    VK_SCROLL 145 </tt> </tt>
<a name="L190"></a><tt class="py-lineno"> 190</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L191"></a><tt class="py-lineno"> 191</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L192"></a><tt class="py-lineno"> 192</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-15" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-15', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-16" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-16', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"app.key"</tt><tt class="py-op">,</tt> <tt class="py-name">keyCode</tt><tt class="py-op">)</tt> </tt>
<a name="L193"></a><tt class="py-lineno"> 193</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-17" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-17', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L194"></a><tt class="py-lineno"> 194</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="maximise"></a><div id="maximise-def"><a name="L195"></a><tt class="py-lineno"> 195</tt> <a class="py-toggle" href="#" id="maximise-toggle" onclick="return toggle('maximise');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#maximise">maximise</a><tt class="py-op">(</tt><tt class="py-param">state</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="maximise-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="maximise-expanded"><a name="L196"></a><tt class="py-lineno"> 196</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L197"></a><tt class="py-lineno"> 197</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L198"></a><tt class="py-lineno"> 198</tt>  <tt class="py-line"><tt class="py-docstring">    Maximises ECOTECT to fill the entire screen. This can be useful if you </tt> </tt>
<a name="L199"></a><tt class="py-lineno"> 199</tt>  <tt class="py-line"><tt class="py-docstring">    need to give an animated presentation or run a demonstration script. </tt> </tt>
<a name="L200"></a><tt class="py-lineno"> 200</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L201"></a><tt class="py-lineno"> 201</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L202"></a><tt class="py-lineno"> 202</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L203"></a><tt class="py-lineno"> 203</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L204"></a><tt class="py-lineno"> 204</tt>  <tt class="py-line"><tt class="py-docstring">    state </tt> </tt>
<a name="L205"></a><tt class="py-lineno"> 205</tt>  <tt class="py-line"><tt class="py-docstring">    An optional parameter that determines whether the application is </tt> </tt>
<a name="L206"></a><tt class="py-lineno"> 206</tt>  <tt class="py-line"><tt class="py-docstring">    maximised or restored to its previous state (true to maximise, false to </tt> </tt>
<a name="L207"></a><tt class="py-lineno"> 207</tt>  <tt class="py-line"><tt class="py-docstring">    restore). If not given, the command toggles between maximised and </tt> </tt>
<a name="L208"></a><tt class="py-lineno"> 208</tt>  <tt class="py-line"><tt class="py-docstring">    normal. This is a boolean value where 1 or true represents the </tt> </tt>
<a name="L209"></a><tt class="py-lineno"> 209</tt>  <tt class="py-line"><tt class="py-docstring">    affirmative and 0 or false the negative.</tt> </tt>
<a name="L210"></a><tt class="py-lineno"> 210</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L211"></a><tt class="py-lineno"> 211</tt>  <tt class="py-line"><tt class="py-docstring">    Here is an example:</tt> </tt>
<a name="L212"></a><tt class="py-lineno"> 212</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L213"></a><tt class="py-lineno"> 213</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; maximise(1)</tt> </tt>
<a name="L214"></a><tt class="py-lineno"> 214</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L215"></a><tt class="py-lineno"> 215</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L216"></a><tt class="py-lineno"> 216</tt>  <tt class="py-line"> </tt>
<a name="L217"></a><tt class="py-lineno"> 217</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-18" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-18', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-19" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-19', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"app.maximise"</tt><tt class="py-op">,</tt> <tt id="link-20" class="py-name" targets="Class py2ecotect.obj._object._Object.state=py2ecotect.obj._object._Object.state-class.html"><a title="py2ecotect.obj._object._Object.state" class="py-name" href="#" onclick="return doclink('link-20', 'state', 'link-20');">state</a></tt><tt class="py-op">)</tt> </tt>
<a name="L218"></a><tt class="py-lineno"> 218</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-21" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-21', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L219"></a><tt class="py-lineno"> 219</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="menu"></a><div id="menu-def"><a name="L220"></a><tt class="py-lineno"> 220</tt> <a class="py-toggle" href="#" id="menu-toggle" onclick="return toggle('menu');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#menu">menu</a><tt class="py-op">(</tt><tt class="py-param">command</tt><tt class="py-op">,</tt> <tt class="py-param">tag</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="menu-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="menu-expanded"><a name="L221"></a><tt class="py-lineno"> 221</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L222"></a><tt class="py-lineno"> 222</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L223"></a><tt class="py-lineno"> 223</tt>  <tt class="py-line"><tt class="py-docstring">    This command is a special method to send interactive commands to the </tt> </tt>
<a name="L224"></a><tt class="py-lineno"> 224</tt>  <tt class="py-line"><tt class="py-docstring">    ECOTECT application. These are very different from other methods in that </tt> </tt>
<a name="L225"></a><tt class="py-lineno"> 225</tt>  <tt class="py-line"><tt class="py-docstring">    they allow you to emulate interactive menu commands and actions. This is </tt> </tt>
<a name="L226"></a><tt class="py-lineno"> 226</tt>  <tt class="py-line"><tt class="py-docstring">    useful for direct command line entry and accessing some functions not </tt> </tt>
<a name="L227"></a><tt class="py-lineno"> 227</tt>  <tt class="py-line"><tt class="py-docstring">    otherwise available, however you will need to be very careful that you </tt> </tt>
<a name="L228"></a><tt class="py-lineno"> 228</tt>  <tt class="py-line"><tt class="py-docstring">    do not include commands that invoke dialog boxes or on-screen prompts </tt> </tt>
<a name="L229"></a><tt class="py-lineno"> 229</tt>  <tt class="py-line"><tt class="py-docstring">    if you intend your script to operate unattended.</tt> </tt>
<a name="L230"></a><tt class="py-lineno"> 230</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L231"></a><tt class="py-lineno"> 231</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L232"></a><tt class="py-lineno"> 232</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L233"></a><tt class="py-lineno"> 233</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L234"></a><tt class="py-lineno"> 234</tt>  <tt class="py-line"><tt class="py-docstring">    command </tt> </tt>
<a name="L235"></a><tt class="py-lineno"> 235</tt>  <tt class="py-line"><tt class="py-docstring">    The command parameter can be given as either a value or a token selected </tt> </tt>
<a name="L236"></a><tt class="py-lineno"> 236</tt>  <tt class="py-line"><tt class="py-docstring">    from the following table. In this case, tokens must be entered in full. </tt> </tt>
<a name="L237"></a><tt class="py-lineno"> 237</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L238"></a><tt class="py-lineno"> 238</tt>  <tt class="py-line"><tt class="py-docstring">    tag </tt> </tt>
<a name="L239"></a><tt class="py-lineno"> 239</tt>  <tt class="py-line"><tt class="py-docstring">    The tag parameter defaults to zero if it is not given and is included </tt> </tt>
<a name="L240"></a><tt class="py-lineno"> 240</tt>  <tt class="py-line"><tt class="py-docstring">    mainly for future extensions.</tt> </tt>
<a name="L241"></a><tt class="py-lineno"> 241</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L242"></a><tt class="py-lineno"> 242</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L243"></a><tt class="py-lineno"> 243</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L244"></a><tt class="py-lineno"> 244</tt>  <tt class="py-line"><tt class="py-docstring">    Available Menu Commands </tt> </tt>
<a name="L245"></a><tt class="py-lineno"> 245</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L246"></a><tt class="py-lineno"> 246</tt>  <tt class="py-line"><tt class="py-docstring">    File Menu </tt> </tt>
<a name="L247"></a><tt class="py-lineno"> 247</tt>  <tt class="py-line"><tt class="py-docstring">        file.new </tt> </tt>
<a name="L248"></a><tt class="py-lineno"> 248</tt>  <tt class="py-line"><tt class="py-docstring">        file.new.window </tt> </tt>
<a name="L249"></a><tt class="py-lineno"> 249</tt>  <tt class="py-line"><tt class="py-docstring">        file.open </tt> </tt>
<a name="L250"></a><tt class="py-lineno"> 250</tt>  <tt class="py-line"><tt class="py-docstring">        file.recentfiles </tt> </tt>
<a name="L251"></a><tt class="py-lineno"> 251</tt>  <tt class="py-line"><tt class="py-docstring">        file.revert </tt> </tt>
<a name="L252"></a><tt class="py-lineno"> 252</tt>  <tt class="py-line"><tt class="py-docstring">        file.save </tt> </tt>
<a name="L253"></a><tt class="py-lineno"> 253</tt>  <tt class="py-line"><tt class="py-docstring">        file.saveas </tt> </tt>
<a name="L254"></a><tt class="py-lineno"> 254</tt>  <tt class="py-line"><tt class="py-docstring">        file.import.3d </tt> </tt>
<a name="L255"></a><tt class="py-lineno"> 255</tt>  <tt class="py-line"><tt class="py-docstring">        file.import </tt> </tt>
<a name="L256"></a><tt class="py-lineno"> 256</tt>  <tt class="py-line"><tt class="py-docstring">        file.export.data </tt> </tt>
<a name="L257"></a><tt class="py-lineno"> 257</tt>  <tt class="py-line"><tt class="py-docstring">        file.export.external </tt> </tt>
<a name="L258"></a><tt class="py-lineno"> 258</tt>  <tt class="py-line"><tt class="py-docstring">        file.export.image </tt> </tt>
<a name="L259"></a><tt class="py-lineno"> 259</tt>  <tt class="py-line"><tt class="py-docstring">        file.export </tt> </tt>
<a name="L260"></a><tt class="py-lineno"> 260</tt>  <tt class="py-line"><tt class="py-docstring">        file.print.setup </tt> </tt>
<a name="L261"></a><tt class="py-lineno"> 261</tt>  <tt class="py-line"><tt class="py-docstring">        file.print </tt> </tt>
<a name="L262"></a><tt class="py-lineno"> 262</tt>  <tt class="py-line"><tt class="py-docstring">        file.projectinfo </tt> </tt>
<a name="L263"></a><tt class="py-lineno"> 263</tt>  <tt class="py-line"><tt class="py-docstring">        file.preferences </tt> </tt>
<a name="L264"></a><tt class="py-lineno"> 264</tt>  <tt class="py-line"><tt class="py-docstring">        file.exit </tt> </tt>
<a name="L265"></a><tt class="py-lineno"> 265</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L266"></a><tt class="py-lineno"> 266</tt>  <tt class="py-line"><tt class="py-docstring">    Misc File Commands </tt> </tt>
<a name="L267"></a><tt class="py-lineno"> 267</tt>  <tt class="py-line"><tt class="py-docstring">        save.results </tt> </tt>
<a name="L268"></a><tt class="py-lineno"> 268</tt>  <tt class="py-line"><tt class="py-docstring">        save.grid </tt> </tt>
<a name="L269"></a><tt class="py-lineno"> 269</tt>  <tt class="py-line"><tt class="py-docstring">        import.grid </tt> </tt>
<a name="L270"></a><tt class="py-lineno"> 270</tt>  <tt class="py-line"><tt class="py-docstring">        export.wrl </tt> </tt>
<a name="L271"></a><tt class="py-lineno"> 271</tt>  <tt class="py-line"><tt class="py-docstring">        export.rad </tt> </tt>
<a name="L272"></a><tt class="py-lineno"> 272</tt>  <tt class="py-line"><tt class="py-docstring">        export.pov </tt> </tt>
<a name="L273"></a><tt class="py-lineno"> 273</tt>  <tt class="py-line"><tt class="py-docstring">        export.dxf </tt> </tt>
<a name="L274"></a><tt class="py-lineno"> 274</tt>  <tt class="py-line"><tt class="py-docstring">        export.htb2 </tt> </tt>
<a name="L275"></a><tt class="py-lineno"> 275</tt>  <tt class="py-line"><tt class="py-docstring">        export.idf </tt> </tt>
<a name="L276"></a><tt class="py-lineno"> 276</tt>  <tt class="py-line"><tt class="py-docstring">        export.doe </tt> </tt>
<a name="L277"></a><tt class="py-lineno"> 277</tt>  <tt class="py-line"><tt class="py-docstring">        export.sbem </tt> </tt>
<a name="L278"></a><tt class="py-lineno"> 278</tt>  <tt class="py-line"><tt class="py-docstring">        export.winair </tt> </tt>
<a name="L279"></a><tt class="py-lineno"> 279</tt>  <tt class="py-line"><tt class="py-docstring">        export.fds </tt> </tt>
<a name="L280"></a><tt class="py-lineno"> 280</tt>  <tt class="py-line"><tt class="py-docstring">        export.espr </tt> </tt>
<a name="L281"></a><tt class="py-lineno"> 281</tt>  <tt class="py-line"><tt class="py-docstring">        export.gbxml</tt> </tt>
<a name="L282"></a><tt class="py-lineno"> 282</tt>  <tt class="py-line"><tt class="py-docstring">         </tt> </tt>
<a name="L283"></a><tt class="py-lineno"> 283</tt>  <tt class="py-line"><tt class="py-docstring">    Edit Menu </tt> </tt>
<a name="L284"></a><tt class="py-lineno"> 284</tt>  <tt class="py-line"><tt class="py-docstring">        edit.undo </tt> </tt>
<a name="L285"></a><tt class="py-lineno"> 285</tt>  <tt class="py-line"><tt class="py-docstring">        edit.repeat </tt> </tt>
<a name="L286"></a><tt class="py-lineno"> 286</tt>  <tt class="py-line"><tt class="py-docstring">        edit.redo </tt> </tt>
<a name="L287"></a><tt class="py-lineno"> 287</tt>  <tt class="py-line"><tt class="py-docstring">        edit.cut </tt> </tt>
<a name="L288"></a><tt class="py-lineno"> 288</tt>  <tt class="py-line"><tt class="py-docstring">        edit.copy </tt> </tt>
<a name="L289"></a><tt class="py-lineno"> 289</tt>  <tt class="py-line"><tt class="py-docstring">        edit.paste </tt> </tt>
<a name="L290"></a><tt class="py-lineno"> 290</tt>  <tt class="py-line"><tt class="py-docstring">        edit.delete </tt> </tt>
<a name="L291"></a><tt class="py-lineno"> 291</tt>  <tt class="py-line"><tt class="py-docstring">        edit.duplicate </tt> </tt>
<a name="L292"></a><tt class="py-lineno"> 292</tt>  <tt class="py-line"><tt class="py-docstring">        edit.morph </tt> </tt>
<a name="L293"></a><tt class="py-lineno"> 293</tt>  <tt class="py-line"><tt class="py-docstring">        edit.facet </tt> </tt>
<a name="L294"></a><tt class="py-lineno"> 294</tt>  <tt class="py-line"><tt class="py-docstring">        edit.offset </tt> </tt>
<a name="L295"></a><tt class="py-lineno"> 295</tt>  <tt class="py-line"><tt class="py-docstring">        edit.no.linking </tt> </tt>
<a name="L296"></a><tt class="py-lineno"> 296</tt>  <tt class="py-line"><tt class="py-docstring">        edit.no.undo </tt> </tt>
<a name="L297"></a><tt class="py-lineno"> 297</tt>  <tt class="py-line"><tt class="py-docstring">        edit.link </tt> </tt>
<a name="L298"></a><tt class="py-lineno"> 298</tt>  <tt class="py-line"><tt class="py-docstring">        edit.unlink </tt> </tt>
<a name="L299"></a><tt class="py-lineno"> 299</tt>  <tt class="py-line"><tt class="py-docstring">        edit.fix </tt> </tt>
<a name="L300"></a><tt class="py-lineno"> 300</tt>  <tt class="py-line"><tt class="py-docstring">        edit.ungroup </tt> </tt>
<a name="L301"></a><tt class="py-lineno"> 301</tt>  <tt class="py-line"><tt class="py-docstring">        edit.group </tt> </tt>
<a name="L302"></a><tt class="py-lineno"> 302</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L303"></a><tt class="py-lineno"> 303</tt>  <tt class="py-line"><tt class="py-docstring">    View Menu </tt> </tt>
<a name="L304"></a><tt class="py-lineno"> 304</tt>  <tt class="py-line"><tt class="py-docstring">        view.undo </tt> </tt>
<a name="L305"></a><tt class="py-lineno"> 305</tt>  <tt class="py-line"><tt class="py-docstring">        view.set </tt> </tt>
<a name="L306"></a><tt class="py-lineno"> 306</tt>  <tt class="py-line"><tt class="py-docstring">        view.plan </tt> </tt>
<a name="L307"></a><tt class="py-lineno"> 307</tt>  <tt class="py-line"><tt class="py-docstring">        view.side </tt> </tt>
<a name="L308"></a><tt class="py-lineno"> 308</tt>  <tt class="py-line"><tt class="py-docstring">        view.front </tt> </tt>
<a name="L309"></a><tt class="py-lineno"> 309</tt>  <tt class="py-line"><tt class="py-docstring">        view.persp </tt> </tt>
<a name="L310"></a><tt class="py-lineno"> 310</tt>  <tt class="py-line"><tt class="py-docstring">        view.axon </tt> </tt>
<a name="L311"></a><tt class="py-lineno"> 311</tt>  <tt class="py-line"><tt class="py-docstring">        view.zoom.win </tt> </tt>
<a name="L312"></a><tt class="py-lineno"> 312</tt>  <tt class="py-line"><tt class="py-docstring">        view.zoom.obj </tt> </tt>
<a name="L313"></a><tt class="py-lineno"> 313</tt>  <tt class="py-line"><tt class="py-docstring">        view.zoom.all </tt> </tt>
<a name="L314"></a><tt class="py-lineno"> 314</tt>  <tt class="py-line"><tt class="py-docstring">        view.fit.grid </tt> </tt>
<a name="L315"></a><tt class="py-lineno"> 315</tt>  <tt class="py-line"><tt class="py-docstring">        view.drag.grid </tt> </tt>
<a name="L316"></a><tt class="py-lineno"> 316</tt>  <tt class="py-line"><tt class="py-docstring">        view.context </tt> </tt>
<a name="L317"></a><tt class="py-lineno"> 317</tt>  <tt class="py-line"><tt class="py-docstring">        view.copy.bmp </tt> </tt>
<a name="L318"></a><tt class="py-lineno"> 318</tt>  <tt class="py-line"><tt class="py-docstring">        view.copy.emf </tt> </tt>
<a name="L319"></a><tt class="py-lineno"> 319</tt>  <tt class="py-line"><tt class="py-docstring">        view.copy </tt> </tt>
<a name="L320"></a><tt class="py-lineno"> 320</tt>  <tt class="py-line"><tt class="py-docstring">        view.save </tt> </tt>
<a name="L321"></a><tt class="py-lineno"> 321</tt>  <tt class="py-line"><tt class="py-docstring">        view.bitmap.show </tt> </tt>
<a name="L322"></a><tt class="py-lineno"> 322</tt>  <tt class="py-line"><tt class="py-docstring">        view.bitmap </tt> </tt>
<a name="L323"></a><tt class="py-lineno"> 323</tt>  <tt class="py-line"><tt class="py-docstring">        view.recall </tt> </tt>
<a name="L324"></a><tt class="py-lineno"> 324</tt>  <tt class="py-line"><tt class="py-docstring">        view.store </tt> </tt>
<a name="L325"></a><tt class="py-lineno"> 325</tt>  <tt class="py-line"><tt class="py-docstring">        view.edit </tt> </tt>
<a name="L326"></a><tt class="py-lineno"> 326</tt>  <tt class="py-line"><tt class="py-docstring">    Select Menu </tt> </tt>
<a name="L327"></a><tt class="py-lineno"> 327</tt>  <tt class="py-line"><tt class="py-docstring">        select.mode </tt> </tt>
<a name="L328"></a><tt class="py-lineno"> 328</tt>  <tt class="py-line"><tt class="py-docstring">        select.polar </tt> </tt>
<a name="L329"></a><tt class="py-lineno"> 329</tt>  <tt class="py-line"><tt class="py-docstring">        select.measure </tt> </tt>
<a name="L330"></a><tt class="py-lineno"> 330</tt>  <tt class="py-line"><tt class="py-docstring">        select.all </tt> </tt>
<a name="L331"></a><tt class="py-lineno"> 331</tt>  <tt class="py-line"><tt class="py-docstring">        select.none </tt> </tt>
<a name="L332"></a><tt class="py-lineno"> 332</tt>  <tt class="py-line"><tt class="py-docstring">        select.invert </tt> </tt>
<a name="L333"></a><tt class="py-lineno"> 333</tt>  <tt class="py-line"><tt class="py-docstring">        select.cells </tt> </tt>
<a name="L334"></a><tt class="py-lineno"> 334</tt>  <tt class="py-line"><tt class="py-docstring">        select.adjacent </tt> </tt>
<a name="L335"></a><tt class="py-lineno"> 335</tt>  <tt class="py-line"><tt class="py-docstring">        select.previous </tt> </tt>
<a name="L336"></a><tt class="py-lineno"> 336</tt>  <tt class="py-line"><tt class="py-docstring">        select.children </tt> </tt>
<a name="L337"></a><tt class="py-lineno"> 337</tt>  <tt class="py-line"><tt class="py-docstring">        select.parent </tt> </tt>
<a name="L338"></a><tt class="py-lineno"> 338</tt>  <tt class="py-line"><tt class="py-docstring">        select.zone.no </tt> </tt>
<a name="L339"></a><tt class="py-lineno"> 339</tt>  <tt class="py-line"><tt class="py-docstring">        select.by.zone </tt> </tt>
<a name="L340"></a><tt class="py-lineno"> 340</tt>  <tt class="py-line"><tt class="py-docstring">        select.by.index </tt> </tt>
<a name="L341"></a><tt class="py-lineno"> 341</tt>  <tt class="py-line"><tt class="py-docstring">        select.by.material </tt> </tt>
<a name="L342"></a><tt class="py-lineno"> 342</tt>  <tt class="py-line"><tt class="py-docstring">        select.by.element </tt> </tt>
<a name="L343"></a><tt class="py-lineno"> 343</tt>  <tt class="py-line"><tt class="py-docstring">        select.by.schedule </tt> </tt>
<a name="L344"></a><tt class="py-lineno"> 344</tt>  <tt class="py-line"><tt class="py-docstring">        select.by.orientation </tt> </tt>
<a name="L345"></a><tt class="py-lineno"> 345</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L346"></a><tt class="py-lineno"> 346</tt>  <tt class="py-line"><tt class="py-docstring">    Modify Menu </tt> </tt>
<a name="L347"></a><tt class="py-lineno"> 347</tt>  <tt class="py-line"><tt class="py-docstring">        modify.moveto.zone </tt> </tt>
<a name="L348"></a><tt class="py-lineno"> 348</tt>  <tt class="py-line"><tt class="py-docstring">        modify.moveto.current </tt> </tt>
<a name="L349"></a><tt class="py-lineno"> 349</tt>  <tt class="py-line"><tt class="py-docstring">        modify.xform.move </tt> </tt>
<a name="L350"></a><tt class="py-lineno"> 350</tt>  <tt class="py-line"><tt class="py-docstring">        modify.xform.rotate </tt> </tt>
<a name="L351"></a><tt class="py-lineno"> 351</tt>  <tt class="py-line"><tt class="py-docstring">        modify.xform.scale </tt> </tt>
<a name="L352"></a><tt class="py-lineno"> 352</tt>  <tt class="py-line"><tt class="py-docstring">        modify.xform.mirror </tt> </tt>
<a name="L353"></a><tt class="py-lineno"> 353</tt>  <tt class="py-line"><tt class="py-docstring">        modify.xform.extrude </tt> </tt>
<a name="L354"></a><tt class="py-lineno"> 354</tt>  <tt class="py-line"><tt class="py-docstring">        modify.xform.vectors </tt> </tt>
<a name="L355"></a><tt class="py-lineno"> 355</tt>  <tt class="py-line"><tt class="py-docstring">        modify.xform.cap </tt> </tt>
<a name="L356"></a><tt class="py-lineno"> 356</tt>  <tt class="py-line"><tt class="py-docstring">        modify.xform.panel </tt> </tt>
<a name="L357"></a><tt class="py-lineno"> 357</tt>  <tt class="py-line"><tt class="py-docstring">        modify.origin.global </tt> </tt>
<a name="L358"></a><tt class="py-lineno"> 358</tt>  <tt class="py-line"><tt class="py-docstring">        modify.origin.selection </tt> </tt>
<a name="L359"></a><tt class="py-lineno"> 359</tt>  <tt class="py-line"><tt class="py-docstring">        modify.origin.centre </tt> </tt>
<a name="L360"></a><tt class="py-lineno"> 360</tt>  <tt class="py-line"><tt class="py-docstring">        modify.origin.reset </tt> </tt>
<a name="L361"></a><tt class="py-lineno"> 361</tt>  <tt class="py-line"><tt class="py-docstring">        modify.origin.xform </tt> </tt>
<a name="L362"></a><tt class="py-lineno"> 362</tt>  <tt class="py-line"><tt class="py-docstring">        modify.assign.shaded </tt> </tt>
<a name="L363"></a><tt class="py-lineno"> 363</tt>  <tt class="py-line"><tt class="py-docstring">        modify.assign.reflector </tt> </tt>
<a name="L364"></a><tt class="py-lineno"> 364</tt>  <tt class="py-line"><tt class="py-docstring">        modify.assign.acoustic </tt> </tt>
<a name="L365"></a><tt class="py-lineno"> 365</tt>  <tt class="py-line"><tt class="py-docstring">        modify.assign.source </tt> </tt>
<a name="L366"></a><tt class="py-lineno"> 366</tt>  <tt class="py-line"><tt class="py-docstring">        modify.cut.assign </tt> </tt>
<a name="L367"></a><tt class="py-lineno"> 367</tt>  <tt class="py-line"><tt class="py-docstring">        modify.cut.extend </tt> </tt>
<a name="L368"></a><tt class="py-lineno"> 368</tt>  <tt class="py-line"><tt class="py-docstring">        modify.cut.trim </tt> </tt>
<a name="L369"></a><tt class="py-lineno"> 369</tt>  <tt class="py-line"><tt class="py-docstring">        modify.insert.node </tt> </tt>
<a name="L370"></a><tt class="py-lineno"> 370</tt>  <tt class="py-line"><tt class="py-docstring">        modify.edit.nodes </tt> </tt>
<a name="L371"></a><tt class="py-lineno"> 371</tt>  <tt class="py-line"><tt class="py-docstring">        modify.delete.node </tt> </tt>
<a name="L372"></a><tt class="py-lineno"> 372</tt>  <tt class="py-line"><tt class="py-docstring">        modify.child.extents </tt> </tt>
<a name="L373"></a><tt class="py-lineno"> 373</tt>  <tt class="py-line"><tt class="py-docstring">        modify.render.poly </tt> </tt>
<a name="L374"></a><tt class="py-lineno"> 374</tt>  <tt class="py-line"><tt class="py-docstring">        modify.reverse </tt> </tt>
<a name="L375"></a><tt class="py-lineno"> 375</tt>  <tt class="py-line"><tt class="py-docstring">        modify.normals.unify </tt> </tt>
<a name="L376"></a><tt class="py-lineno"> 376</tt>  <tt class="py-line"><tt class="py-docstring">        modify.normals.flip </tt> </tt>
<a name="L377"></a><tt class="py-lineno"> 377</tt>  <tt class="py-line"><tt class="py-docstring">        modify.normals.orient </tt> </tt>
<a name="L378"></a><tt class="py-lineno"> 378</tt>  <tt class="py-line"><tt class="py-docstring">        modify.create.lights </tt> </tt>
<a name="L379"></a><tt class="py-lineno"> 379</tt>  <tt class="py-line"><tt class="py-docstring">        modify.nodes.float </tt> </tt>
<a name="L380"></a><tt class="py-lineno"> 380</tt>  <tt class="py-line"><tt class="py-docstring">        modify.nodes.drop </tt> </tt>
<a name="L381"></a><tt class="py-lineno"> 381</tt>  <tt class="py-line"><tt class="py-docstring">        modify.surface.grid </tt> </tt>
<a name="L382"></a><tt class="py-lineno"> 382</tt>  <tt class="py-line"><tt class="py-docstring">        modify.subdivide.tiles </tt> </tt>
<a name="L383"></a><tt class="py-lineno"> 383</tt>  <tt class="py-line"><tt class="py-docstring">        modify.subdivide.points </tt> </tt>
<a name="L384"></a><tt class="py-lineno"> 384</tt>  <tt class="py-line"><tt class="py-docstring">        modify.subdivide.line </tt> </tt>
<a name="L385"></a><tt class="py-lineno"> 385</tt>  <tt class="py-line"><tt class="py-docstring">        modify.simplify.count </tt> </tt>
<a name="L386"></a><tt class="py-lineno"> 386</tt>  <tt class="py-line"><tt class="py-docstring">        modify.simplify.angle </tt> </tt>
<a name="L387"></a><tt class="py-lineno"> 387</tt>  <tt class="py-line"><tt class="py-docstring">        modify.merge.triangles </tt> </tt>
<a name="L388"></a><tt class="py-lineno"> 388</tt>  <tt class="py-line"><tt class="py-docstring">        modify.merge.polygons </tt> </tt>
<a name="L389"></a><tt class="py-lineno"> 389</tt>  <tt class="py-line"><tt class="py-docstring">        modify.align.grid </tt> </tt>
<a name="L390"></a><tt class="py-lineno"> 390</tt>  <tt class="py-line"><tt class="py-docstring">        modify.break </tt> </tt>
<a name="L391"></a><tt class="py-lineno"> 391</tt>  <tt class="py-line"><tt class="py-docstring">        modify.intersect </tt> </tt>
<a name="L392"></a><tt class="py-lineno"> 392</tt>  <tt class="py-line"><tt class="py-docstring">        modify.join </tt> </tt>
<a name="L393"></a><tt class="py-lineno"> 393</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L394"></a><tt class="py-lineno"> 394</tt>  <tt class="py-line"><tt class="py-docstring">    Draw Menu </tt> </tt>
<a name="L395"></a><tt class="py-lineno"> 395</tt>  <tt class="py-line"><tt class="py-docstring">        draw.point </tt> </tt>
<a name="L396"></a><tt class="py-lineno"> 396</tt>  <tt class="py-line"><tt class="py-docstring">        draw.line </tt> </tt>
<a name="L397"></a><tt class="py-lineno"> 397</tt>  <tt class="py-line"><tt class="py-docstring">        draw.plane </tt> </tt>
<a name="L398"></a><tt class="py-lineno"> 398</tt>  <tt class="py-line"><tt class="py-docstring">        draw.partion </tt> </tt>
<a name="L399"></a><tt class="py-lineno"> 399</tt>  <tt class="py-line"><tt class="py-docstring">        draw.zone </tt> </tt>
<a name="L400"></a><tt class="py-lineno"> 400</tt>  <tt class="py-line"><tt class="py-docstring">        draw.insert.child </tt> </tt>
<a name="L401"></a><tt class="py-lineno"> 401</tt>  <tt class="py-line"><tt class="py-docstring">        draw.child.window </tt> </tt>
<a name="L402"></a><tt class="py-lineno"> 402</tt>  <tt class="py-line"><tt class="py-docstring">        draw.child.void </tt> </tt>
<a name="L403"></a><tt class="py-lineno"> 403</tt>  <tt class="py-line"><tt class="py-docstring">        draw.child.panel </tt> </tt>
<a name="L404"></a><tt class="py-lineno"> 404</tt>  <tt class="py-line"><tt class="py-docstring">        draw.child.door </tt> </tt>
<a name="L405"></a><tt class="py-lineno"> 405</tt>  <tt class="py-line"><tt class="py-docstring">        draw.light </tt> </tt>
<a name="L406"></a><tt class="py-lineno"> 406</tt>  <tt class="py-line"><tt class="py-docstring">        draw.speaker </tt> </tt>
<a name="L407"></a><tt class="py-lineno"> 407</tt>  <tt class="py-line"><tt class="py-docstring">        draw.appliance </tt> </tt>
<a name="L408"></a><tt class="py-lineno"> 408</tt>  <tt class="py-line"><tt class="py-docstring">        draw.camera.objects </tt> </tt>
<a name="L409"></a><tt class="py-lineno"> 409</tt>  <tt class="py-line"><tt class="py-docstring">        draw.camera.plan </tt> </tt>
<a name="L410"></a><tt class="py-lineno"> 410</tt>  <tt class="py-line"><tt class="py-docstring">        draw.camera.windows </tt> </tt>
<a name="L411"></a><tt class="py-lineno"> 411</tt>  <tt class="py-line"><tt class="py-docstring">        draw.camera.from </tt> </tt>
<a name="L412"></a><tt class="py-lineno"> 412</tt>  <tt class="py-line"><tt class="py-docstring">        draw.camera.inside </tt> </tt>
<a name="L413"></a><tt class="py-lineno"> 413</tt>  <tt class="py-line"><tt class="py-docstring">        draw.camera </tt> </tt>
<a name="L414"></a><tt class="py-lineno"> 414</tt>  <tt class="py-line"><tt class="py-docstring">        draw.rect.plane </tt> </tt>
<a name="L415"></a><tt class="py-lineno"> 415</tt>  <tt class="py-line"><tt class="py-docstring">        draw.rect.prism </tt> </tt>
<a name="L416"></a><tt class="py-lineno"> 416</tt>  <tt class="py-line"><tt class="py-docstring">        draw.rect.zone </tt> </tt>
<a name="L417"></a><tt class="py-lineno"> 417</tt>  <tt class="py-line"><tt class="py-docstring">        draw.arc </tt> </tt>
<a name="L418"></a><tt class="py-lineno"> 418</tt>  <tt class="py-line"><tt class="py-docstring">        draw.bezier </tt> </tt>
<a name="L419"></a><tt class="py-lineno"> 419</tt>  <tt class="py-line"><tt class="py-docstring">        draw.spline </tt> </tt>
<a name="L420"></a><tt class="py-lineno"> 420</tt>  <tt class="py-line"><tt class="py-docstring">        draw.roof </tt> </tt>
<a name="L421"></a><tt class="py-lineno"> 421</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L422"></a><tt class="py-lineno"> 422</tt>  <tt class="py-line"><tt class="py-docstring">    Model Menu </tt> </tt>
<a name="L423"></a><tt class="py-lineno"> 423</tt>  <tt class="py-line"><tt class="py-docstring">        model.location </tt> </tt>
<a name="L424"></a><tt class="py-lineno"> 424</tt>  <tt class="py-line"><tt class="py-docstring">        model.inspector </tt> </tt>
<a name="L425"></a><tt class="py-lineno"> 425</tt>  <tt class="py-line"><tt class="py-docstring">        model.zone.manager </tt> </tt>
<a name="L426"></a><tt class="py-lineno"> 426</tt>  <tt class="py-line"><tt class="py-docstring">        model.elements </tt> </tt>
<a name="L427"></a><tt class="py-lineno"> 427</tt>  <tt class="py-line"><tt class="py-docstring">        model.schedules </tt> </tt>
<a name="L428"></a><tt class="py-lineno"> 428</tt>  <tt class="py-line"><tt class="py-docstring">        model.systems </tt> </tt>
<a name="L429"></a><tt class="py-lineno"> 429</tt>  <tt class="py-line"><tt class="py-docstring">        model.settings </tt> </tt>
<a name="L430"></a><tt class="py-lineno"> 430</tt>  <tt class="py-line"><tt class="py-docstring">        model.moveto.zone </tt> </tt>
<a name="L431"></a><tt class="py-lineno"> 431</tt>  <tt class="py-line"><tt class="py-docstring">        model.moveto.current </tt> </tt>
<a name="L432"></a><tt class="py-lineno"> 432</tt>  <tt class="py-line"><tt class="py-docstring">        model.make.current </tt> </tt>
<a name="L433"></a><tt class="py-lineno"> 433</tt>  <tt class="py-line"><tt class="py-docstring">        model.zone.current </tt> </tt>
<a name="L434"></a><tt class="py-lineno"> 434</tt>  <tt class="py-line"><tt class="py-docstring">        model.zone.selected </tt> </tt>
<a name="L435"></a><tt class="py-lineno"> 435</tt>  <tt class="py-line"><tt class="py-docstring">        model.zone.all </tt> </tt>
<a name="L436"></a><tt class="py-lineno"> 436</tt>  <tt class="py-line"><tt class="py-docstring">        model.zone.hide </tt> </tt>
<a name="L437"></a><tt class="py-lineno"> 437</tt>  <tt class="py-line"><tt class="py-docstring">        model.zone.off </tt> </tt>
<a name="L438"></a><tt class="py-lineno"> 438</tt>  <tt class="py-line"><tt class="py-docstring">        model.zone.lock </tt> </tt>
<a name="L439"></a><tt class="py-lineno"> 439</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L440"></a><tt class="py-lineno"> 440</tt>  <tt class="py-line"><tt class="py-docstring">    Display Menu </tt> </tt>
<a name="L441"></a><tt class="py-lineno"> 441</tt>  <tt class="py-line"><tt class="py-docstring">        display.model </tt> </tt>
<a name="L442"></a><tt class="py-lineno"> 442</tt>  <tt class="py-line"><tt class="py-docstring">        display.shadows </tt> </tt>
<a name="L443"></a><tt class="py-lineno"> 443</tt>  <tt class="py-line"><tt class="py-docstring">        display.normals </tt> </tt>
<a name="L444"></a><tt class="py-lineno"> 444</tt>  <tt class="py-line"><tt class="py-docstring">        display.sketch </tt> </tt>
<a name="L445"></a><tt class="py-lineno"> 445</tt>  <tt class="py-line"><tt class="py-docstring">        display &lt;value&gt; </tt> </tt>
<a name="L446"></a><tt class="py-lineno"> 446</tt>  <tt class="py-line"><tt class="py-docstring">        display.attr.1 </tt> </tt>
<a name="L447"></a><tt class="py-lineno"> 447</tt>  <tt class="py-line"><tt class="py-docstring">        display.attr.2 </tt> </tt>
<a name="L448"></a><tt class="py-lineno"> 448</tt>  <tt class="py-line"><tt class="py-docstring">        display.attr.3 </tt> </tt>
<a name="L449"></a><tt class="py-lineno"> 449</tt>  <tt class="py-line"><tt class="py-docstring">        display.attr.values </tt> </tt>
<a name="L450"></a><tt class="py-lineno"> 450</tt>  <tt class="py-line"><tt class="py-docstring">        display.attr.numbers </tt> </tt>
<a name="L451"></a><tt class="py-lineno"> 451</tt>  <tt class="py-line"><tt class="py-docstring">        display.attr.vectors </tt> </tt>
<a name="L452"></a><tt class="py-lineno"> 452</tt>  <tt class="py-line"><tt class="py-docstring">        display.attr.colours </tt> </tt>
<a name="L453"></a><tt class="py-lineno"> 453</tt>  <tt class="py-line"><tt class="py-docstring">        display.attr.scale </tt> </tt>
<a name="L454"></a><tt class="py-lineno"> 454</tt>  <tt class="py-line"><tt class="py-docstring">        display.attr.properties </tt> </tt>
<a name="L455"></a><tt class="py-lineno"> 455</tt>  <tt class="py-line"><tt class="py-docstring">        display.attr &lt;value&gt; </tt> </tt>
<a name="L456"></a><tt class="py-lineno"> 456</tt>  <tt class="py-line"><tt class="py-docstring">        display.opengl </tt> </tt>
<a name="L457"></a><tt class="py-lineno"> 457</tt>  <tt class="py-line"><tt class="py-docstring">        display.vrml </tt> </tt>
<a name="L458"></a><tt class="py-lineno"> 458</tt>  <tt class="py-line"><tt class="py-docstring">        display.grid </tt> </tt>
<a name="L459"></a><tt class="py-lineno"> 459</tt>  <tt class="py-line"><tt class="py-docstring">        display.rays </tt> </tt>
<a name="L460"></a><tt class="py-lineno"> 460</tt>  <tt class="py-line"><tt class="py-docstring">        display.origin </tt> </tt>
<a name="L461"></a><tt class="py-lineno"> 461</tt>  <tt class="py-line"><tt class="py-docstring">        display.bitmap </tt> </tt>
<a name="L462"></a><tt class="py-lineno"> 462</tt>  <tt class="py-line"><tt class="py-docstring">        display.normal </tt> </tt>
<a name="L463"></a><tt class="py-lineno"> 463</tt>  <tt class="py-line"><tt class="py-docstring">        display.detail.low </tt> </tt>
<a name="L464"></a><tt class="py-lineno"> 464</tt>  <tt class="py-line"><tt class="py-docstring">        display.detail.partial </tt> </tt>
<a name="L465"></a><tt class="py-lineno"> 465</tt>  <tt class="py-line"><tt class="py-docstring">        display.detail.full </tt> </tt>
<a name="L466"></a><tt class="py-lineno"> 466</tt>  <tt class="py-line"><tt class="py-docstring">        display.detail.nodes </tt> </tt>
<a name="L467"></a><tt class="py-lineno"> 467</tt>  <tt class="py-line"><tt class="py-docstring">        display.shadow.daily </tt> </tt>
<a name="L468"></a><tt class="py-lineno"> 468</tt>  <tt class="py-line"><tt class="py-docstring">        display.shadow.annual </tt> </tt>
<a name="L469"></a><tt class="py-lineno"> 469</tt>  <tt class="py-line"><tt class="py-docstring">        display.shadow.footprint </tt> </tt>
<a name="L470"></a><tt class="py-lineno"> 470</tt>  <tt class="py-line"><tt class="py-docstring">        display.shadow.outlines </tt> </tt>
<a name="L471"></a><tt class="py-lineno"> 471</tt>  <tt class="py-line"><tt class="py-docstring">        display.shadow.ground </tt> </tt>
<a name="L472"></a><tt class="py-lineno"> 472</tt>  <tt class="py-line"><tt class="py-docstring">        display.shadow.reverse </tt> </tt>
<a name="L473"></a><tt class="py-lineno"> 473</tt>  <tt class="py-line"><tt class="py-docstring">        display.shadow.cast </tt> </tt>
<a name="L474"></a><tt class="py-lineno"> 474</tt>  <tt class="py-line"><tt class="py-docstring">        display.shadow.receive </tt> </tt>
<a name="L475"></a><tt class="py-lineno"> 475</tt>  <tt class="py-line"><tt class="py-docstring">        display.shadow.selected </tt> </tt>
<a name="L476"></a><tt class="py-lineno"> 476</tt>  <tt class="py-line"><tt class="py-docstring">        display.shadow.transparent </tt> </tt>
<a name="L477"></a><tt class="py-lineno"> 477</tt>  <tt class="py-line"><tt class="py-docstring">        display.shadow.obstructions </tt> </tt>
<a name="L478"></a><tt class="py-lineno"> 478</tt>  <tt class="py-line"><tt class="py-docstring">        display.shadow.reflections </tt> </tt>
<a name="L479"></a><tt class="py-lineno"> 479</tt>  <tt class="py-line"><tt class="py-docstring">        display.shadow.shadows </tt> </tt>
<a name="L480"></a><tt class="py-lineno"> 480</tt>  <tt class="py-line"><tt class="py-docstring">        display.rays.static </tt> </tt>
<a name="L481"></a><tt class="py-lineno"> 481</tt>  <tt class="py-line"><tt class="py-docstring">        display.rays.coverage </tt> </tt>
<a name="L482"></a><tt class="py-lineno"> 482</tt>  <tt class="py-line"><tt class="py-docstring">        display.rays.incidence </tt> </tt>
<a name="L483"></a><tt class="py-lineno"> 483</tt>  <tt class="py-line"><tt class="py-docstring">        display.rays.particles </tt> </tt>
<a name="L484"></a><tt class="py-lineno"> 484</tt>  <tt class="py-line"><tt class="py-docstring">        display.rays.rays </tt> </tt>
<a name="L485"></a><tt class="py-lineno"> 485</tt>  <tt class="py-line"><tt class="py-docstring">        display.rays.forwards </tt> </tt>
<a name="L486"></a><tt class="py-lineno"> 486</tt>  <tt class="py-line"><tt class="py-docstring">        display.rays.backwards </tt> </tt>
<a name="L487"></a><tt class="py-lineno"> 487</tt>  <tt class="py-line"><tt class="py-docstring">        display.rays.cycle </tt> </tt>
<a name="L488"></a><tt class="py-lineno"> 488</tt>  <tt class="py-line"><tt class="py-docstring">        display.rays.scale </tt> </tt>
<a name="L489"></a><tt class="py-lineno"> 489</tt>  <tt class="py-line"><tt class="py-docstring">        display.rays.clear </tt> </tt>
<a name="L490"></a><tt class="py-lineno"> 490</tt>  <tt class="py-line"><tt class="py-docstring">        display.grid.extents </tt> </tt>
<a name="L491"></a><tt class="py-lineno"> 491</tt>  <tt class="py-line"><tt class="py-docstring">        display.grid.spacing </tt> </tt>
<a name="L492"></a><tt class="py-lineno"> 492</tt>  <tt class="py-line"><tt class="py-docstring">        display.grid.autofit </tt> </tt>
<a name="L493"></a><tt class="py-lineno"> 493</tt>  <tt class="py-line"><tt class="py-docstring">        display.grid.volumetric </tt> </tt>
<a name="L494"></a><tt class="py-lineno"> 494</tt>  <tt class="py-line"><tt class="py-docstring">        display.grid.triangulate </tt> </tt>
<a name="L495"></a><tt class="py-lineno"> 495</tt>  <tt class="py-line"><tt class="py-docstring">        display.grid.properties </tt> </tt>
<a name="L496"></a><tt class="py-lineno"> 496</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L497"></a><tt class="py-lineno"> 497</tt>  <tt class="py-line"><tt class="py-docstring">    Calculate Menu </tt> </tt>
<a name="L498"></a><tt class="py-lineno"> 498</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.volumes </tt> </tt>
<a name="L499"></a><tt class="py-lineno"> 499</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.adjacencies </tt> </tt>
<a name="L500"></a><tt class="py-lineno"> 500</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.shading.wizard </tt> </tt>
<a name="L501"></a><tt class="py-lineno"> 501</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.shading.extrude </tt> </tt>
<a name="L502"></a><tt class="py-lineno"> 502</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.shading.potential </tt> </tt>
<a name="L503"></a><tt class="py-lineno"> 503</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.shading.hourly </tt> </tt>
<a name="L504"></a><tt class="py-lineno"> 504</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.shading.annual </tt> </tt>
<a name="L505"></a><tt class="py-lineno"> 505</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.shading.monthly </tt> </tt>
<a name="L506"></a><tt class="py-lineno"> 506</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.shading.profile </tt> </tt>
<a name="L507"></a><tt class="py-lineno"> 507</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.shading.range </tt> </tt>
<a name="L508"></a><tt class="py-lineno"> 508</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.shading.rays </tt> </tt>
<a name="L509"></a><tt class="py-lineno"> 509</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.shading.project </tt> </tt>
<a name="L510"></a><tt class="py-lineno"> 510</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.shading.view </tt> </tt>
<a name="L511"></a><tt class="py-lineno"> 511</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.stereograph </tt> </tt>
<a name="L512"></a><tt class="py-lineno"> 512</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.solar.access </tt> </tt>
<a name="L513"></a><tt class="py-lineno"> 513</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.solar.exposure </tt> </tt>
<a name="L514"></a><tt class="py-lineno"> 514</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.lighting </tt> </tt>
<a name="L515"></a><tt class="py-lineno"> 515</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.rightotlight </tt> </tt>
<a name="L516"></a><tt class="py-lineno"> 516</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.photoelectric </tt> </tt>
<a name="L517"></a><tt class="py-lineno"> 517</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.autonomy </tt> </tt>
<a name="L518"></a><tt class="py-lineno"> 518</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.thermal </tt> </tt>
<a name="L519"></a><tt class="py-lineno"> 519</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.comfort </tt> </tt>
<a name="L520"></a><tt class="py-lineno"> 520</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.regs.uk </tt> </tt>
<a name="L521"></a><tt class="py-lineno"> 521</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.acoustic.rays </tt> </tt>
<a name="L522"></a><tt class="py-lineno"> 522</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.acoustic.reverb </tt> </tt>
<a name="L523"></a><tt class="py-lineno"> 523</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.acoustic.response </tt> </tt>
<a name="L524"></a><tt class="py-lineno"> 524</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.visibility </tt> </tt>
<a name="L525"></a><tt class="py-lineno"> 525</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.winds </tt> </tt>
<a name="L526"></a><tt class="py-lineno"> 526</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.resources </tt> </tt>
<a name="L527"></a><tt class="py-lineno"> 527</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.costs </tt> </tt>
<a name="L528"></a><tt class="py-lineno"> 528</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.errors </tt> </tt>
<a name="L529"></a><tt class="py-lineno"> 529</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.output </tt> </tt>
<a name="L530"></a><tt class="py-lineno"> 530</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.analysis.grid </tt> </tt>
<a name="L531"></a><tt class="py-lineno"> 531</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.weather </tt> </tt>
<a name="L532"></a><tt class="py-lineno"> 532</tt>  <tt class="py-line"><tt class="py-docstring">        calculate.time </tt> </tt>
<a name="L533"></a><tt class="py-lineno"> 533</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L534"></a><tt class="py-lineno"> 534</tt>  <tt class="py-line"><tt class="py-docstring">    Tools Menu </tt> </tt>
<a name="L535"></a><tt class="py-lineno"> 535</tt>  <tt class="py-line"><tt class="py-docstring">        tools.command </tt> </tt>
<a name="L536"></a><tt class="py-lineno"> 536</tt>  <tt class="py-line"><tt class="py-docstring">        tools.clearfiles </tt> </tt>
<a name="L537"></a><tt class="py-lineno"> 537</tt>  <tt class="py-line"><tt class="py-docstring">        tools.script </tt> </tt>
<a name="L538"></a><tt class="py-lineno"> 538</tt>  <tt class="py-line"><tt class="py-docstring">        tools.wizard </tt> </tt>
<a name="L539"></a><tt class="py-lineno"> 539</tt>  <tt class="py-line"><tt class="py-docstring">        tools.animation </tt> </tt>
<a name="L540"></a><tt class="py-lineno"> 540</tt>  <tt class="py-line"><tt class="py-docstring">        tools.weather </tt> </tt>
<a name="L541"></a><tt class="py-lineno"> 541</tt>  <tt class="py-line"><tt class="py-docstring">        tools.world.locations </tt> </tt>
<a name="L542"></a><tt class="py-lineno"> 542</tt>  <tt class="py-line"><tt class="py-docstring">        tools.world.map </tt> </tt>
<a name="L543"></a><tt class="py-lineno"> 543</tt>  <tt class="py-line"><tt class="py-docstring">        tools.analysis </tt> </tt>
<a name="L544"></a><tt class="py-lineno"> 544</tt>  <tt class="py-line"><tt class="py-docstring">        tools.radiance </tt> </tt>
<a name="L545"></a><tt class="py-lineno"> 545</tt>  <tt class="py-line"><tt class="py-docstring">        tools.lcaid </tt> </tt>
<a name="L546"></a><tt class="py-lineno"> 546</tt>  <tt class="py-line"><tt class="py-docstring">        tools.edit </tt> </tt>
<a name="L547"></a><tt class="py-lineno"> 547</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L548"></a><tt class="py-lineno"> 548</tt>  <tt class="py-line"><tt class="py-docstring">    Help Menu </tt> </tt>
<a name="L549"></a><tt class="py-lineno"> 549</tt>  <tt class="py-line"><tt class="py-docstring">        help.topics </tt> </tt>
<a name="L550"></a><tt class="py-lineno"> 550</tt>  <tt class="py-line"><tt class="py-docstring">        help.howdoi </tt> </tt>
<a name="L551"></a><tt class="py-lineno"> 551</tt>  <tt class="py-line"><tt class="py-docstring">        help.context </tt> </tt>
<a name="L552"></a><tt class="py-lineno"> 552</tt>  <tt class="py-line"><tt class="py-docstring">        help.web.support </tt> </tt>
<a name="L553"></a><tt class="py-lineno"> 553</tt>  <tt class="py-line"><tt class="py-docstring">        help.teaching.package </tt> </tt>
<a name="L554"></a><tt class="py-lineno"> 554</tt>  <tt class="py-line"><tt class="py-docstring">        help.showarrow </tt> </tt>
<a name="L555"></a><tt class="py-lineno"> 555</tt>  <tt class="py-line"><tt class="py-docstring">        help.registration </tt> </tt>
<a name="L556"></a><tt class="py-lineno"> 556</tt>  <tt class="py-line"><tt class="py-docstring">        help.about </tt> </tt>
<a name="L557"></a><tt class="py-lineno"> 557</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L558"></a><tt class="py-lineno"> 558</tt>  <tt class="py-line"><tt class="py-docstring">    Context Menu </tt> </tt>
<a name="L559"></a><tt class="py-lineno"> 559</tt>  <tt class="py-line"><tt class="py-docstring">        context.grid.nodes </tt> </tt>
<a name="L560"></a><tt class="py-lineno"> 560</tt>  <tt class="py-line"><tt class="py-docstring">        context.grid.hide </tt> </tt>
<a name="L561"></a><tt class="py-lineno"> 561</tt>  <tt class="py-line"><tt class="py-docstring">        context.grid.show </tt> </tt>
<a name="L562"></a><tt class="py-lineno"> 562</tt>  <tt class="py-line"><tt class="py-docstring">        context.grid.extents </tt> </tt>
<a name="L563"></a><tt class="py-lineno"> 563</tt>  <tt class="py-line"><tt class="py-docstring">        context.grid.spacing </tt> </tt>
<a name="L564"></a><tt class="py-lineno"> 564</tt>  <tt class="py-line"><tt class="py-docstring">        context.node.type </tt> </tt>
<a name="L565"></a><tt class="py-lineno"> 565</tt>  <tt class="py-line"><tt class="py-docstring">        context.node.smooth </tt> </tt>
<a name="L566"></a><tt class="py-lineno"> 566</tt>  <tt class="py-line"><tt class="py-docstring">        context.line.render </tt> </tt>
<a name="L567"></a><tt class="py-lineno"> 567</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L568"></a><tt class="py-lineno"> 568</tt>  <tt class="py-line"><tt class="py-docstring">    Snap Menu </tt> </tt>
<a name="L569"></a><tt class="py-lineno"> 569</tt>  <tt class="py-line"><tt class="py-docstring">        snap.none </tt> </tt>
<a name="L570"></a><tt class="py-lineno"> 570</tt>  <tt class="py-line"><tt class="py-docstring">        snap.grid </tt> </tt>
<a name="L571"></a><tt class="py-lineno"> 571</tt>  <tt class="py-line"><tt class="py-docstring">        snap.align </tt> </tt>
<a name="L572"></a><tt class="py-lineno"> 572</tt>  <tt class="py-line"><tt class="py-docstring">        snap.ortho </tt> </tt>
<a name="L573"></a><tt class="py-lineno"> 573</tt>  <tt class="py-line"><tt class="py-docstring">        snap.centre </tt> </tt>
<a name="L574"></a><tt class="py-lineno"> 574</tt>  <tt class="py-line"><tt class="py-docstring">        snap.point </tt> </tt>
<a name="L575"></a><tt class="py-lineno"> 575</tt>  <tt class="py-line"><tt class="py-docstring">        snap.midpt </tt> </tt>
<a name="L576"></a><tt class="py-lineno"> 576</tt>  <tt class="py-line"><tt class="py-docstring">        snap.intersect </tt> </tt>
<a name="L577"></a><tt class="py-lineno"> 577</tt>  <tt class="py-line"><tt class="py-docstring">        snap.line </tt> </tt>
<a name="L578"></a><tt class="py-lineno"> 578</tt>  <tt class="py-line"><tt class="py-docstring">        snap.settings </tt> </tt>
<a name="L579"></a><tt class="py-lineno"> 579</tt>  <tt class="py-line"><tt class="py-docstring">        snap &lt;value&gt; </tt> </tt>
<a name="L580"></a><tt class="py-lineno"> 580</tt>  <tt class="py-line"><tt class="py-docstring">        </tt> </tt>
<a name="L581"></a><tt class="py-lineno"> 581</tt>  <tt class="py-line"><tt class="py-docstring">    Here is an example:</tt> </tt>
<a name="L582"></a><tt class="py-lineno"> 582</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L583"></a><tt class="py-lineno"> 583</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; menu("file.export.external")</tt> </tt>
<a name="L584"></a><tt class="py-lineno"> 584</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L585"></a><tt class="py-lineno"> 585</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L586"></a><tt class="py-lineno"> 586</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-22" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-22', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-23" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-23', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"app.menu"</tt><tt class="py-op">,</tt> <tt class="py-name">command</tt><tt class="py-op">,</tt><tt id="link-24" class="py-name" targets="Method py2ecotect.doc.select.Select.tag()=py2ecotect.doc.select.Select-class.html#tag"><a title="py2ecotect.doc.select.Select.tag" class="py-name" href="#" onclick="return doclink('link-24', 'tag', 'link-24');">tag</a></tt><tt class="py-op">)</tt> </tt>
<a name="L587"></a><tt class="py-lineno"> 587</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-25" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-25', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L588"></a><tt class="py-lineno"> 588</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="minimise"></a><div id="minimise-def"><a name="L589"></a><tt class="py-lineno"> 589</tt> <a class="py-toggle" href="#" id="minimise-toggle" onclick="return toggle('minimise');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#minimise">minimise</a><tt class="py-op">(</tt><tt class="py-param">state</tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="minimise-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="minimise-expanded"><a name="L590"></a><tt class="py-lineno"> 590</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L591"></a><tt class="py-lineno"> 591</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L592"></a><tt class="py-lineno"> 592</tt>  <tt class="py-line"><tt class="py-docstring">    Minimises ECOTECT to the task bar. This can be useful if you have a long </tt> </tt>
<a name="L593"></a><tt class="py-lineno"> 593</tt>  <tt class="py-line"><tt class="py-docstring">    calculation to perform within a script and want to use the computer for </tt> </tt>
<a name="L594"></a><tt class="py-lineno"> 594</tt>  <tt class="py-line"><tt class="py-docstring">    other things while it runs.</tt> </tt>
<a name="L595"></a><tt class="py-lineno"> 595</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L596"></a><tt class="py-lineno"> 596</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L597"></a><tt class="py-lineno"> 597</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L598"></a><tt class="py-lineno"> 598</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L599"></a><tt class="py-lineno"> 599</tt>  <tt class="py-line"><tt class="py-docstring">    state </tt> </tt>
<a name="L600"></a><tt class="py-lineno"> 600</tt>  <tt class="py-line"><tt class="py-docstring">    An optional parameter that determines whether the application is </tt> </tt>
<a name="L601"></a><tt class="py-lineno"> 601</tt>  <tt class="py-line"><tt class="py-docstring">    minimised or restored to its previous state (true to minimise, false to </tt> </tt>
<a name="L602"></a><tt class="py-lineno"> 602</tt>  <tt class="py-line"><tt class="py-docstring">    restore). If not given, the command toggles between minimised and </tt> </tt>
<a name="L603"></a><tt class="py-lineno"> 603</tt>  <tt class="py-line"><tt class="py-docstring">    normal. This is a boolean value where 1 or true represents the </tt> </tt>
<a name="L604"></a><tt class="py-lineno"> 604</tt>  <tt class="py-line"><tt class="py-docstring">    affirmative and 0 or false the negative.</tt> </tt>
<a name="L605"></a><tt class="py-lineno"> 605</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L606"></a><tt class="py-lineno"> 606</tt>  <tt class="py-line"><tt class="py-docstring">    Here is an example:</tt> </tt>
<a name="L607"></a><tt class="py-lineno"> 607</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L608"></a><tt class="py-lineno"> 608</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; minimise(1)</tt> </tt>
<a name="L609"></a><tt class="py-lineno"> 609</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L610"></a><tt class="py-lineno"> 610</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L611"></a><tt class="py-lineno"> 611</tt>  <tt class="py-line"> </tt>
<a name="L612"></a><tt class="py-lineno"> 612</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-26" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-26', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-27" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-27', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"app.minimise"</tt><tt class="py-op">,</tt> <tt id="link-28" class="py-name"><a title="py2ecotect.obj._object._Object.state" class="py-name" href="#" onclick="return doclink('link-28', 'state', 'link-20');">state</a></tt><tt class="py-op">)</tt> </tt>
<a name="L613"></a><tt class="py-lineno"> 613</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-29" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-29', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L614"></a><tt class="py-lineno"> 614</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="mouse_event"></a><div id="mouse_event-def"><a name="L615"></a><tt class="py-lineno"> 615</tt> <a class="py-toggle" href="#" id="mouse_event-toggle" onclick="return toggle('mouse_event');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#mouse_event">mouse_event</a><tt class="py-op">(</tt><tt class="py-param">action</tt><tt class="py-op">,</tt> <tt class="py-param">x</tt><tt class="py-op">,</tt> <tt class="py-param">y</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="mouse_event-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="mouse_event-expanded"><a name="L616"></a><tt class="py-lineno"> 616</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L617"></a><tt class="py-lineno"> 617</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L618"></a><tt class="py-lineno"> 618</tt>  <tt class="py-line"><tt class="py-docstring">    This is not a command for the faint hearted and is very experimental at </tt> </tt>
<a name="L619"></a><tt class="py-lineno"> 619</tt>  <tt class="py-line"><tt class="py-docstring">    this stage (see below). It can be used to emulate user mouse actions. </tt> </tt>
<a name="L620"></a><tt class="py-lineno"> 620</tt>  <tt class="py-line"><tt class="py-docstring">    The action tokens are given in the table below whereas the x and y </tt> </tt>
<a name="L621"></a><tt class="py-lineno"> 621</tt>  <tt class="py-line"><tt class="py-docstring">    values give the position in screen pixels where the event is to take </tt> </tt>
<a name="L622"></a><tt class="py-lineno"> 622</tt>  <tt class="py-line"><tt class="py-docstring">    place, relative to the top left corner of the main application window. </tt> </tt>
<a name="L623"></a><tt class="py-lineno"> 623</tt>  <tt class="py-line"><tt class="py-docstring">    If called from methods in the graph, sunpath, opengl or view objects, </tt> </tt>
<a name="L624"></a><tt class="py-lineno"> 624</tt>  <tt class="py-line"><tt class="py-docstring">    the pixel values are relative to the top left corner of the graphics </tt> </tt>
<a name="L625"></a><tt class="py-lineno"> 625</tt>  <tt class="py-line"><tt class="py-docstring">    canvas in each window.</tt> </tt>
<a name="L626"></a><tt class="py-lineno"> 626</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L627"></a><tt class="py-lineno"> 627</tt>  <tt class="py-line"><tt class="py-docstring">    This command is actually a leftover from early versions of ECOTECT which </tt> </tt>
<a name="L628"></a><tt class="py-lineno"> 628</tt>  <tt class="py-line"><tt class="py-docstring">    had a macro record and playback function. This function seemed to work </tt> </tt>
<a name="L629"></a><tt class="py-lineno"> 629</tt>  <tt class="py-line"><tt class="py-docstring">    great - on the same machine - however the complexities of system metrics </tt> </tt>
<a name="L630"></a><tt class="py-lineno"> 630</tt>  <tt class="py-line"><tt class="py-docstring">    and user preference settings for font and titlebar sizes was soon </tt> </tt>
<a name="L631"></a><tt class="py-lineno"> 631</tt>  <tt class="py-line"><tt class="py-docstring">    discovered when macros were moved from machine to machine. However, when </tt> </tt>
<a name="L632"></a><tt class="py-lineno"> 632</tt>  <tt class="py-line"><tt class="py-docstring">    used with care, this command can be so useful in a show-and-tell </tt> </tt>
<a name="L633"></a><tt class="py-lineno"> 633</tt>  <tt class="py-line"><tt class="py-docstring">    demonstration on a known machine that I've left it in. Plus, it is </tt> </tt>
<a name="L634"></a><tt class="py-lineno"> 634</tt>  <tt class="py-line"><tt class="py-docstring">    currently the only way of physically invoking context menus.</tt> </tt>
<a name="L635"></a><tt class="py-lineno"> 635</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L636"></a><tt class="py-lineno"> 636</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L637"></a><tt class="py-lineno"> 637</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L638"></a><tt class="py-lineno"> 638</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L639"></a><tt class="py-lineno"> 639</tt>  <tt class="py-line"><tt class="py-docstring">    action </tt> </tt>
<a name="L640"></a><tt class="py-lineno"> 640</tt>  <tt class="py-line"><tt class="py-docstring">    This parameter specifies the type of action/operation to use with the </tt> </tt>
<a name="L641"></a><tt class="py-lineno"> 641</tt>  <tt class="py-line"><tt class="py-docstring">    mouse at the given screen location. See the following table for details. </tt> </tt>
<a name="L642"></a><tt class="py-lineno"> 642</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L643"></a><tt class="py-lineno"> 643</tt>  <tt class="py-line"><tt class="py-docstring">    x </tt> </tt>
<a name="L644"></a><tt class="py-lineno"> 644</tt>  <tt class="py-line"><tt class="py-docstring">    Gives the horizontal X location of the desired mouse operation in pixel </tt> </tt>
<a name="L645"></a><tt class="py-lineno"> 645</tt>  <tt class="py-line"><tt class="py-docstring">    coordinates relative to the left corner of the application window. </tt> </tt>
<a name="L646"></a><tt class="py-lineno"> 646</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L647"></a><tt class="py-lineno"> 647</tt>  <tt class="py-line"><tt class="py-docstring">    y </tt> </tt>
<a name="L648"></a><tt class="py-lineno"> 648</tt>  <tt class="py-line"><tt class="py-docstring">    Gives the vertical Y location of the desired mouse operation in pixel </tt> </tt>
<a name="L649"></a><tt class="py-lineno"> 649</tt>  <tt class="py-line"><tt class="py-docstring">    coordinates relative to the top corner of the application window.</tt> </tt>
<a name="L650"></a><tt class="py-lineno"> 650</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L651"></a><tt class="py-lineno"> 651</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L652"></a><tt class="py-lineno"> 652</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L653"></a><tt class="py-lineno"> 653</tt>  <tt class="py-line"><tt class="py-docstring">    Available Mouse Actions </tt> </tt>
<a name="L654"></a><tt class="py-lineno"> 654</tt>  <tt class="py-line"><tt class="py-docstring">    Token     Description </tt> </tt>
<a name="L655"></a><tt class="py-lineno"> 655</tt>  <tt class="py-line"><tt class="py-docstring">    move     move mouse to new position </tt> </tt>
<a name="L656"></a><tt class="py-lineno"> 656</tt>  <tt class="py-line"><tt class="py-docstring">    lclick     Left mouse button clicked </tt> </tt>
<a name="L657"></a><tt class="py-lineno"> 657</tt>  <tt class="py-line"><tt class="py-docstring">    ldown     Left mouse button pressed </tt> </tt>
<a name="L658"></a><tt class="py-lineno"> 658</tt>  <tt class="py-line"><tt class="py-docstring">    lup     Left mouse button released </tt> </tt>
<a name="L659"></a><tt class="py-lineno"> 659</tt>  <tt class="py-line"><tt class="py-docstring">    rclick     Right mouse button clicked </tt> </tt>
<a name="L660"></a><tt class="py-lineno"> 660</tt>  <tt class="py-line"><tt class="py-docstring">    rdown     Right mouse button pressed </tt> </tt>
<a name="L661"></a><tt class="py-lineno"> 661</tt>  <tt class="py-line"><tt class="py-docstring">    rup     Right mouse button released </tt> </tt>
<a name="L662"></a><tt class="py-lineno"> 662</tt>  <tt class="py-line"><tt class="py-docstring">    mclick     Middle mouse button clicked </tt> </tt>
<a name="L663"></a><tt class="py-lineno"> 663</tt>  <tt class="py-line"><tt class="py-docstring">    mdown     Middle mouse button pressed </tt> </tt>
<a name="L664"></a><tt class="py-lineno"> 664</tt>  <tt class="py-line"><tt class="py-docstring">    mup     Middle mouse button released </tt> </tt>
<a name="L665"></a><tt class="py-lineno"> 665</tt>  <tt class="py-line"><tt class="py-docstring">    wdown     Mouse wheel pressed </tt> </tt>
<a name="L666"></a><tt class="py-lineno"> 666</tt>  <tt class="py-line"><tt class="py-docstring">    wup     Mouse wheel released </tt> </tt>
<a name="L667"></a><tt class="py-lineno"> 667</tt>  <tt class="py-line"><tt class="py-docstring">    ldblclick     Left mouse button double-clicked </tt> </tt>
<a name="L668"></a><tt class="py-lineno"> 668</tt>  <tt class="py-line"><tt class="py-docstring">    rdblclick     Right mouse button double-clicked </tt> </tt>
<a name="L669"></a><tt class="py-lineno"> 669</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L670"></a><tt class="py-lineno"> 670</tt>  <tt class="py-line"><tt class="py-docstring">    Here is an example:</tt> </tt>
<a name="L671"></a><tt class="py-lineno"> 671</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L672"></a><tt class="py-lineno"> 672</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; mouseevent("rclick", 100, 150)</tt> </tt>
<a name="L673"></a><tt class="py-lineno"> 673</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L674"></a><tt class="py-lineno"> 674</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L675"></a><tt class="py-lineno"> 675</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-30" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-30', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-31" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-31', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"app.mouseevent"</tt><tt class="py-op">,</tt> <tt id="link-32" class="py-name"><a title="py2ecotect.app.radiance.Radiance.action" class="py-name" href="#" onclick="return doclink('link-32', 'action', 'link-8');">action</a></tt><tt class="py-op">,</tt>  </tt>
<a name="L676"></a><tt class="py-lineno"> 676</tt>  <tt class="py-line">                                                  <tt class="py-name">x</tt><tt class="py-op">,</tt> <tt class="py-name">y</tt><tt class="py-op">)</tt> </tt>
<a name="L677"></a><tt class="py-lineno"> 677</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-33" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-33', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L678"></a><tt class="py-lineno"> 678</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="progress"></a><div id="progress-def"><a name="L679"></a><tt class="py-lineno"> 679</tt> <a class="py-toggle" href="#" id="progress-toggle" onclick="return toggle('progress');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#progress">progress</a><tt class="py-op">(</tt><tt class="py-param">percent</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="progress-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="progress-expanded"><a name="L680"></a><tt class="py-lineno"> 680</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L681"></a><tt class="py-lineno"> 681</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L682"></a><tt class="py-lineno"> 682</tt>  <tt class="py-line"><tt class="py-docstring">    Updates the progress indicator displayed in the application status bar. </tt> </tt>
<a name="L683"></a><tt class="py-lineno"> 683</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L684"></a><tt class="py-lineno"> 684</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L685"></a><tt class="py-lineno"> 685</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L686"></a><tt class="py-lineno"> 686</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L687"></a><tt class="py-lineno"> 687</tt>  <tt class="py-line"><tt class="py-docstring">    percent </tt> </tt>
<a name="L688"></a><tt class="py-lineno"> 688</tt>  <tt class="py-line"><tt class="py-docstring">    This parameter gives the progress indicator value is given as either a </tt> </tt>
<a name="L689"></a><tt class="py-lineno"> 689</tt>  <tt class="py-line"><tt class="py-docstring">    fraction (0-1) or a percentage (1-100). Any value greater than 1 is </tt> </tt>
<a name="L690"></a><tt class="py-lineno"> 690</tt>  <tt class="py-line"><tt class="py-docstring">    interpreted as a percentage whereas any value between 0 and 1 as a </tt> </tt>
<a name="L691"></a><tt class="py-lineno"> 691</tt>  <tt class="py-line"><tt class="py-docstring">    fraction. A value equal to or less than zero (0) hides the status bar. </tt> </tt>
<a name="L692"></a><tt class="py-lineno"> 692</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L693"></a><tt class="py-lineno"> 693</tt>  <tt class="py-line"><tt class="py-docstring">    Here is an example:</tt> </tt>
<a name="L694"></a><tt class="py-lineno"> 694</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L695"></a><tt class="py-lineno"> 695</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; progress(25)</tt> </tt>
<a name="L696"></a><tt class="py-lineno"> 696</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L697"></a><tt class="py-lineno"> 697</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L698"></a><tt class="py-lineno"> 698</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-34" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-34', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-35" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-35', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"app.progress"</tt><tt class="py-op">,</tt> <tt class="py-name">percent</tt><tt class="py-op">)</tt> </tt>
<a name="L699"></a><tt class="py-lineno"> 699</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-36" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-36', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L700"></a><tt class="py-lineno"> 700</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="run"></a><div id="run-def"><a name="L701"></a><tt class="py-lineno"> 701</tt> <a class="py-toggle" href="#" id="run-toggle" onclick="return toggle('run');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#run">run</a><tt class="py-op">(</tt><tt class="py-param">script</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="run-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="run-expanded"><a name="L702"></a><tt class="py-lineno"> 702</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L703"></a><tt class="py-lineno"> 703</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L704"></a><tt class="py-lineno"> 704</tt>  <tt class="py-line"><tt class="py-docstring">    This command instructs ECOTECT to run the specified script file. The </tt> </tt>
<a name="L705"></a><tt class="py-lineno"> 705</tt>  <tt class="py-line"><tt class="py-docstring">    current script will pause whilst the new script is run, and will then </tt> </tt>
<a name="L706"></a><tt class="py-lineno"> 706</tt>  <tt class="py-line"><tt class="py-docstring">    continue its own execution. If you are running a script from the Script </tt> </tt>
<a name="L707"></a><tt class="py-lineno"> 707</tt>  <tt class="py-line"><tt class="py-docstring">    Manager, this command is useful as ECOTECT will run the new script </tt> </tt>
<a name="L708"></a><tt class="py-lineno"> 708</tt>  <tt class="py-line"><tt class="py-docstring">    itself, significantly reducing the inter-process communication overhead. </tt> </tt>
<a name="L709"></a><tt class="py-lineno"> 709</tt>  <tt class="py-line"><tt class="py-docstring">    You can also use the dofile() LUA command to execute a new script as </tt> </tt>
<a name="L710"></a><tt class="py-lineno"> 710</tt>  <tt class="py-line"><tt class="py-docstring">    part of an existing one, however this is simply run as an extra command </tt> </tt>
<a name="L711"></a><tt class="py-lineno"> 711</tt>  <tt class="py-line"><tt class="py-docstring">    within the current script environment. </tt> </tt>
<a name="L712"></a><tt class="py-lineno"> 712</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L713"></a><tt class="py-lineno"> 713</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L714"></a><tt class="py-lineno"> 714</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L715"></a><tt class="py-lineno"> 715</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L716"></a><tt class="py-lineno"> 716</tt>  <tt class="py-line"><tt class="py-docstring">    script </tt> </tt>
<a name="L717"></a><tt class="py-lineno"> 717</tt>  <tt class="py-line"><tt class="py-docstring">    Gives the name of the script to run. If you do not give the full </tt> </tt>
<a name="L718"></a><tt class="py-lineno"> 718</tt>  <tt class="py-line"><tt class="py-docstring">    pathname of file, ECOTECT will first search for it in the same directory </tt> </tt>
<a name="L719"></a><tt class="py-lineno"> 719</tt>  <tt class="py-line"><tt class="py-docstring">    as the current script, then the current model, then the default model </tt> </tt>
<a name="L720"></a><tt class="py-lineno"> 720</tt>  <tt class="py-line"><tt class="py-docstring">    directory and then in subfolders within the Square One installation </tt> </tt>
<a name="L721"></a><tt class="py-lineno"> 721</tt>  <tt class="py-line"><tt class="py-docstring">    directory.</tt> </tt>
<a name="L722"></a><tt class="py-lineno"> 722</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L723"></a><tt class="py-lineno"> 723</tt>  <tt class="py-line"><tt class="py-docstring">    Here is an example:</tt> </tt>
<a name="L724"></a><tt class="py-lineno"> 724</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L725"></a><tt class="py-lineno"> 725</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; run("AcousticRays.scr")</tt> </tt>
<a name="L726"></a><tt class="py-lineno"> 726</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L727"></a><tt class="py-lineno"> 727</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L728"></a><tt class="py-lineno"> 728</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-37" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-37', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-38" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-38', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"app.run"</tt><tt class="py-op">,</tt> <tt class="py-name">script</tt><tt class="py-op">)</tt> </tt>
<a name="L729"></a><tt class="py-lineno"> 729</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-39" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-39', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L730"></a><tt class="py-lineno"> 730</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="status"></a><div id="status-def"><a name="L731"></a><tt class="py-lineno"> 731</tt> <a class="py-toggle" href="#" id="status-toggle" onclick="return toggle('status');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#status">status</a><tt class="py-op">(</tt><tt class="py-param">msg</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="status-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="status-expanded"><a name="L732"></a><tt class="py-lineno"> 732</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L733"></a><tt class="py-lineno"> 733</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L734"></a><tt class="py-lineno"> 734</tt>  <tt class="py-line"><tt class="py-docstring">    This function displays messages in the main application window's status </tt> </tt>
<a name="L735"></a><tt class="py-lineno"> 735</tt>  <tt class="py-line"><tt class="py-docstring">    bar. Sometimes you will see two messages in this area; the first </tt> </tt>
<a name="L736"></a><tt class="py-lineno"> 736</tt>  <tt class="py-line"><tt class="py-docstring">    specifying what action is taking place and the second in the </tt> </tt>
<a name="L737"></a><tt class="py-lineno"> 737</tt>  <tt class="py-line"><tt class="py-docstring">    status/progress area saying 'Please wait...' or similar. To include both </tt> </tt>
<a name="L738"></a><tt class="py-lineno"> 738</tt>  <tt class="py-line"><tt class="py-docstring">    messages, simply separate them with the '|' character. </tt> </tt>
<a name="L739"></a><tt class="py-lineno"> 739</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L740"></a><tt class="py-lineno"> 740</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L741"></a><tt class="py-lineno"> 741</tt>  <tt class="py-line"><tt class="py-docstring">    This command takes the following parameters.</tt> </tt>
<a name="L742"></a><tt class="py-lineno"> 742</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L743"></a><tt class="py-lineno"> 743</tt>  <tt class="py-line"><tt class="py-docstring">    msg </tt> </tt>
<a name="L744"></a><tt class="py-lineno"> 744</tt>  <tt class="py-line"><tt class="py-docstring">    This parameter gives the message to be displayed. If this message </tt> </tt>
<a name="L745"></a><tt class="py-lineno"> 745</tt>  <tt class="py-line"><tt class="py-docstring">    contains the '|' character, it will be split with the first shown in the </tt> </tt>
<a name="L746"></a><tt class="py-lineno"> 746</tt>  <tt class="py-line"><tt class="py-docstring">    action area and the second in the progress area. </tt> </tt>
<a name="L747"></a><tt class="py-lineno"> 747</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L748"></a><tt class="py-lineno"> 748</tt>  <tt class="py-line"><tt class="py-docstring">    Here is an example:</tt> </tt>
<a name="L749"></a><tt class="py-lineno"> 749</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L750"></a><tt class="py-lineno"> 750</tt>  <tt class="py-line"><tt class="py-docstring">    &gt;&gt;&gt; status("Reading zone data|Please wait...")</tt> </tt>
<a name="L751"></a><tt class="py-lineno"> 751</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L752"></a><tt class="py-lineno"> 752</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt>  </tt>
<a name="L753"></a><tt class="py-lineno"> 753</tt>  <tt class="py-line"> </tt>
<a name="L754"></a><tt class="py-lineno"> 754</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-40" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-40', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-41" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-41', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"app.status"</tt><tt class="py-op">,</tt> <tt class="py-name">msg</tt><tt class="py-op">)</tt> </tt>
<a name="L755"></a><tt class="py-lineno"> 755</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-42" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-42', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L756"></a><tt class="py-lineno"> 756</tt>  <tt class="py-line"><tt class="py-comment">#===========================================================================</tt> </tt>
<a name="L757"></a><tt class="py-lineno"> 757</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Properties</tt> </tt>
<a name="L758"></a><tt class="py-lineno"> 758</tt>  <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#===========================================================================</tt> </tt>
<a name="get_computer"></a><div id="get_computer-def"><a name="L759"></a><tt class="py-lineno"> 759</tt> <a class="py-toggle" href="#" id="get_computer-toggle" onclick="return toggle('get_computer');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#get_computer">get_computer</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_computer-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_computer-expanded"><a name="L760"></a><tt class="py-lineno"> 760</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L761"></a><tt class="py-lineno"> 761</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L762"></a><tt class="py-lineno"> 762</tt>  <tt class="py-line"><tt class="py-docstring">    Returns the system name of the computer the application is currently </tt> </tt>
<a name="L763"></a><tt class="py-lineno"> 763</tt>  <tt class="py-line"><tt class="py-docstring">    running on. </tt> </tt>
<a name="L764"></a><tt class="py-lineno"> 764</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L765"></a><tt class="py-lineno"> 765</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L766"></a><tt class="py-lineno"> 766</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L767"></a><tt class="py-lineno"> 767</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L768"></a><tt class="py-lineno"> 768</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L769"></a><tt class="py-lineno"> 769</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L770"></a><tt class="py-lineno"> 770</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L771"></a><tt class="py-lineno"> 771</tt>  <tt class="py-line"><tt class="py-docstring">    name </tt> </tt>
<a name="L772"></a><tt class="py-lineno"> 772</tt>  <tt class="py-line"><tt class="py-docstring">    A text string containing the computer name. </tt> </tt>
<a name="L773"></a><tt class="py-lineno"> 773</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L774"></a><tt class="py-lineno"> 774</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L775"></a><tt class="py-lineno"> 775</tt>  <tt class="py-line"> </tt>
<a name="L776"></a><tt class="py-lineno"> 776</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-43" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-43', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.app.computer"</tt><tt class="py-op">)</tt> </tt>
<a name="L777"></a><tt class="py-lineno"> 777</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-44" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-44', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-45" class="py-name" targets="Function py2ecotect._util._convert_str_to_type()=py2ecotect._util-module.html#_convert_str_to_type"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-45', '_convert_str_to_type', 'link-45');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L778"></a><tt class="py-lineno"> 778</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_image"></a><div id="get_image-def"><a name="L779"></a><tt class="py-lineno"> 779</tt> <a class="py-toggle" href="#" id="get_image-toggle" onclick="return toggle('get_image');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#get_image">get_image</a><tt class="py-op">(</tt><tt class="py-param">type</tt><tt class="py-op">,</tt> <tt class="py-param">name</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_image-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_image-expanded"><a name="L780"></a><tt class="py-lineno"> 780</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L781"></a><tt class="py-lineno"> 781</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L782"></a><tt class="py-lineno"> 782</tt>  <tt class="py-line"><tt class="py-docstring">    Creates an image of the specified item in the system $TEMP directory and </tt> </tt>
<a name="L783"></a><tt class="py-lineno"> 783</tt>  <tt class="py-line"><tt class="py-docstring">    returns the pathname. This command is useful for embedding images in </tt> </tt>
<a name="L784"></a><tt class="py-lineno"> 784</tt>  <tt class="py-line"><tt class="py-docstring">    your own HTML reports. </tt> </tt>
<a name="L785"></a><tt class="py-lineno"> 785</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L786"></a><tt class="py-lineno"> 786</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L787"></a><tt class="py-lineno"> 787</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L788"></a><tt class="py-lineno"> 788</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L789"></a><tt class="py-lineno"> 789</tt>  <tt class="py-line"><tt class="py-docstring">    type </tt> </tt>
<a name="L790"></a><tt class="py-lineno"> 790</tt>  <tt class="py-line"><tt class="py-docstring">    Specify the type of image to create. See the following table for </tt> </tt>
<a name="L791"></a><tt class="py-lineno"> 791</tt>  <tt class="py-line"><tt class="py-docstring">    available values for this parameter. </tt> </tt>
<a name="L792"></a><tt class="py-lineno"> 792</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L793"></a><tt class="py-lineno"> 793</tt>  <tt class="py-line"><tt class="py-docstring">    [name] </tt> </tt>
<a name="L794"></a><tt class="py-lineno"> 794</tt>  <tt class="py-line"><tt class="py-docstring">    If not given, a pseudo-random unique filename will be used for the </tt> </tt>
<a name="L795"></a><tt class="py-lineno"> 795</tt>  <tt class="py-line"><tt class="py-docstring">    image. If you provide a name, then this will be used. Either way, image </tt> </tt>
<a name="L796"></a><tt class="py-lineno"> 796</tt>  <tt class="py-line"><tt class="py-docstring">    files are always in JPG format and generated within the system $TEMP </tt> </tt>
<a name="L797"></a><tt class="py-lineno"> 797</tt>  <tt class="py-line"><tt class="py-docstring">    directory. This is to ensure that they can be saved and that the </tt> </tt>
<a name="L798"></a><tt class="py-lineno"> 798</tt>  <tt class="py-line"><tt class="py-docstring">    resulting directory exists irrespective of which computer the script is </tt> </tt>
<a name="L799"></a><tt class="py-lineno"> 799</tt>  <tt class="py-line"><tt class="py-docstring">    run on. You can use the 'Save As' command within your browser to store a </tt> </tt>
<a name="L800"></a><tt class="py-lineno"> 800</tt>  <tt class="py-line"><tt class="py-docstring">    complete copy of the resulting page along with it's images.</tt> </tt>
<a name="L801"></a><tt class="py-lineno"> 801</tt>  <tt class="py-line"><tt class="py-docstring">     </tt> </tt>
<a name="L802"></a><tt class="py-lineno"> 802</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L803"></a><tt class="py-lineno"> 803</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L804"></a><tt class="py-lineno"> 804</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L805"></a><tt class="py-lineno"> 805</tt>  <tt class="py-line"><tt class="py-docstring">    imgPath </tt> </tt>
<a name="L806"></a><tt class="py-lineno"> 806</tt>  <tt class="py-line"><tt class="py-docstring">    The full path to the image file in the $TEMP directory.</tt> </tt>
<a name="L807"></a><tt class="py-lineno"> 807</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L808"></a><tt class="py-lineno"> 808</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L809"></a><tt class="py-lineno"> 809</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L810"></a><tt class="py-lineno"> 810</tt>  <tt class="py-line"><tt class="py-docstring">    Application Image Types </tt> </tt>
<a name="L811"></a><tt class="py-lineno"> 811</tt>  <tt class="py-line"><tt class="py-docstring">    Token # Description </tt> </tt>
<a name="L812"></a><tt class="py-lineno"> 812</tt>  <tt class="py-line"><tt class="py-docstring">    view 0 The 3D EDITOR Page </tt> </tt>
<a name="L813"></a><tt class="py-lineno"> 813</tt>  <tt class="py-line"><tt class="py-docstring">    opengl 1 The VISUALISE Page </tt> </tt>
<a name="L814"></a><tt class="py-lineno"> 814</tt>  <tt class="py-line"><tt class="py-docstring">    sunpath 2 The current SunPath diagram </tt> </tt>
<a name="L815"></a><tt class="py-lineno"> 815</tt>  <tt class="py-line"><tt class="py-docstring">    graph 3 The ANALYSIS graph </tt> </tt>
<a name="L816"></a><tt class="py-lineno"> 816</tt>  <tt class="py-line"><tt class="py-docstring">    layers 4 The material layer image </tt> </tt>
<a name="L817"></a><tt class="py-lineno"> 817</tt>  <tt class="py-line"><tt class="py-docstring">    schedule 5 The current schedule </tt> </tt>
<a name="L818"></a><tt class="py-lineno"> 818</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L819"></a><tt class="py-lineno"> 819</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L820"></a><tt class="py-lineno"> 820</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-46" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-46', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-47" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-47', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.app.image"</tt><tt class="py-op">,</tt> <tt id="link-48" class="py-name"><a title="py2ecotect.app.movie.Movie.type" class="py-name" href="#" onclick="return doclink('link-48', 'type', 'link-4');">type</a></tt><tt class="py-op">,</tt>  </tt>
<a name="L821"></a><tt class="py-lineno"> 821</tt>  <tt class="py-line">                                                  <tt id="link-49" class="py-name" targets="Variable py2ecotect.ent.zone.Zone.name=py2ecotect.ent.zone.Zone-class.html#name"><a title="py2ecotect.ent.zone.Zone.name" class="py-name" href="#" onclick="return doclink('link-49', 'name', 'link-49');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L822"></a><tt class="py-lineno"> 822</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-50" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-50', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L823"></a><tt class="py-lineno"> 823</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-51" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-51', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-52" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-52', '_convert_str_to_type', 'link-45');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L824"></a><tt class="py-lineno"> 824</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_menu_tool"></a><div id="get_menu_tool-def"><a name="L825"></a><tt class="py-lineno"> 825</tt> <a class="py-toggle" href="#" id="get_menu_tool-toggle" onclick="return toggle('get_menu_tool');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#get_menu_tool">get_menu_tool</a><tt class="py-op">(</tt><tt class="py-param">index</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_menu_tool-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_menu_tool-expanded"><a name="L826"></a><tt class="py-lineno"> 826</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L827"></a><tt class="py-lineno"> 827</tt>  <tt class="py-line"><tt class="py-docstring">    Retrieve the user-defined tool data at the specified position within the </tt> </tt>
<a name="L828"></a><tt class="py-lineno"> 828</tt>  <tt class="py-line"><tt class="py-docstring">    Tools menu. Use this command to check for an empty value before adding a </tt> </tt>
<a name="L829"></a><tt class="py-lineno"> 829</tt>  <tt class="py-line"><tt class="py-docstring">    new user tool. </tt> </tt>
<a name="L830"></a><tt class="py-lineno"> 830</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L831"></a><tt class="py-lineno"> 831</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L832"></a><tt class="py-lineno"> 832</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L833"></a><tt class="py-lineno"> 833</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L834"></a><tt class="py-lineno"> 834</tt>  <tt class="py-line"><tt class="py-docstring">    index </tt> </tt>
<a name="L835"></a><tt class="py-lineno"> 835</tt>  <tt class="py-line"><tt class="py-docstring">    An integer value between 1 and 9 representing the index of the user tool </tt> </tt>
<a name="L836"></a><tt class="py-lineno"> 836</tt>  <tt class="py-line"><tt class="py-docstring">    required. </tt> </tt>
<a name="L837"></a><tt class="py-lineno"> 837</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L838"></a><tt class="py-lineno"> 838</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L839"></a><tt class="py-lineno"> 839</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L840"></a><tt class="py-lineno"> 840</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L841"></a><tt class="py-lineno"> 841</tt>  <tt class="py-line"><tt class="py-docstring">    name </tt> </tt>
<a name="L842"></a><tt class="py-lineno"> 842</tt>  <tt class="py-line"><tt class="py-docstring">    The name of the item as it is displayed in the menu itself. </tt> </tt>
<a name="L843"></a><tt class="py-lineno"> 843</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L844"></a><tt class="py-lineno"> 844</tt>  <tt class="py-line"><tt class="py-docstring">    filepath </tt> </tt>
<a name="L845"></a><tt class="py-lineno"> 845</tt>  <tt class="py-line"><tt class="py-docstring">    The full pathname to the associated executable file. </tt> </tt>
<a name="L846"></a><tt class="py-lineno"> 846</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L847"></a><tt class="py-lineno"> 847</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L848"></a><tt class="py-lineno"> 848</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-53" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-53', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-54" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-54', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.app.menu.tool"</tt><tt class="py-op">,</tt> <tt id="link-55" class="py-name" targets="Method py2ecotect.doc.select.Select.index()=py2ecotect.doc.select.Select-class.html#index"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-55', 'index', 'link-55');">index</a></tt><tt class="py-op">)</tt> </tt>
<a name="L849"></a><tt class="py-lineno"> 849</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-56" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-56', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L850"></a><tt class="py-lineno"> 850</tt>  <tt class="py-line">    <tt class="py-keyword">print</tt> <tt class="py-name">val</tt> </tt>
<a name="L851"></a><tt class="py-lineno"> 851</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-57" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-57', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-58" class="py-name" targets="Function py2ecotect._util._convert_str_to_list()=py2ecotect._util-module.html#_convert_str_to_list"><a title="py2ecotect._util._convert_str_to_list" class="py-name" href="#" onclick="return doclink('link-58', '_convert_str_to_list', 'link-58');">_convert_str_to_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt>   </tt>
</div><a name="L852"></a><tt class="py-lineno"> 852</tt>  <tt class="py-line"> </tt>
<a name="set_menu_tool"></a><div id="set_menu_tool-def"><a name="L853"></a><tt class="py-lineno"> 853</tt> <a class="py-toggle" href="#" id="set_menu_tool-toggle" onclick="return toggle('set_menu_tool');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#set_menu_tool">set_menu_tool</a><tt class="py-op">(</tt><tt class="py-param">index</tt><tt class="py-op">,</tt> <tt class="py-param">name_path</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_menu_tool-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_menu_tool-expanded"><a name="L854"></a><tt class="py-lineno"> 854</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L855"></a><tt class="py-lineno"> 855</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L856"></a><tt class="py-lineno"> 856</tt>  <tt class="py-line"><tt class="py-docstring">    Set the user-defined tool data at the specified position within the </tt> </tt>
<a name="L857"></a><tt class="py-lineno"> 857</tt>  <tt class="py-line"><tt class="py-docstring">    Tools submenu. Use this command to add a new tool to the menu or edit </tt> </tt>
<a name="L858"></a><tt class="py-lineno"> 858</tt>  <tt class="py-line"><tt class="py-docstring">    an existing item. </tt> </tt>
<a name="L859"></a><tt class="py-lineno"> 859</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L860"></a><tt class="py-lineno"> 860</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L861"></a><tt class="py-lineno"> 861</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L862"></a><tt class="py-lineno"> 862</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L863"></a><tt class="py-lineno"> 863</tt>  <tt class="py-line"><tt class="py-docstring">    index </tt> </tt>
<a name="L864"></a><tt class="py-lineno"> 864</tt>  <tt class="py-line"><tt class="py-docstring">    An integer value between 1 and 9 representing the index of the user </tt> </tt>
<a name="L865"></a><tt class="py-lineno"> 865</tt>  <tt class="py-line"><tt class="py-docstring">    tool required. </tt> </tt>
<a name="L866"></a><tt class="py-lineno"> 866</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L867"></a><tt class="py-lineno"> 867</tt>  <tt class="py-line"><tt class="py-docstring">    name|path </tt> </tt>
<a name="L868"></a><tt class="py-lineno"> 868</tt>  <tt class="py-line"><tt class="py-docstring">    A text string beginning with the name of the menu item followed by the </tt> </tt>
<a name="L869"></a><tt class="py-lineno"> 869</tt>  <tt class="py-line"><tt class="py-docstring">    full pathname of the associated executable file, separated by the '|' </tt> </tt>
<a name="L870"></a><tt class="py-lineno"> 870</tt>  <tt class="py-line"><tt class="py-docstring">    character.</tt> </tt>
<a name="L871"></a><tt class="py-lineno"> 871</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L872"></a><tt class="py-lineno"> 872</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L873"></a><tt class="py-lineno"> 873</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-59" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-59', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-60" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-60', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.app.menu.tool"</tt><tt class="py-op">,</tt>  </tt>
<a name="L874"></a><tt class="py-lineno"> 874</tt>  <tt class="py-line">                                                  <tt id="link-61" class="py-name"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-61', 'index', 'link-55');">index</a></tt><tt class="py-op">,</tt> <tt class="py-name">name_path</tt><tt class="py-op">)</tt> </tt>
<a name="L875"></a><tt class="py-lineno"> 875</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-62" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-62', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L876"></a><tt class="py-lineno"> 876</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_menu_wizard"></a><div id="get_menu_wizard-def"><a name="L877"></a><tt class="py-lineno"> 877</tt> <a class="py-toggle" href="#" id="get_menu_wizard-toggle" onclick="return toggle('get_menu_wizard');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#get_menu_wizard">get_menu_wizard</a><tt class="py-op">(</tt><tt class="py-param">index</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_menu_wizard-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_menu_wizard-expanded"><a name="L878"></a><tt class="py-lineno"> 878</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L879"></a><tt class="py-lineno"> 879</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L880"></a><tt class="py-lineno"> 880</tt>  <tt class="py-line"><tt class="py-docstring">    Retrieve the user-defined wizard data at the specified position within </tt> </tt>
<a name="L881"></a><tt class="py-lineno"> 881</tt>  <tt class="py-line"><tt class="py-docstring">    the Draw &gt; Geometry Wizards submenu. Use this command to check for an </tt> </tt>
<a name="L882"></a><tt class="py-lineno"> 882</tt>  <tt class="py-line"><tt class="py-docstring">    empty value before adding a new user wizard. </tt> </tt>
<a name="L883"></a><tt class="py-lineno"> 883</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L884"></a><tt class="py-lineno"> 884</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L885"></a><tt class="py-lineno"> 885</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L886"></a><tt class="py-lineno"> 886</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L887"></a><tt class="py-lineno"> 887</tt>  <tt class="py-line"><tt class="py-docstring">    index </tt> </tt>
<a name="L888"></a><tt class="py-lineno"> 888</tt>  <tt class="py-line"><tt class="py-docstring">    An integer value between 1 and 9 representing the index of the wizard </tt> </tt>
<a name="L889"></a><tt class="py-lineno"> 889</tt>  <tt class="py-line"><tt class="py-docstring">    required. </tt> </tt>
<a name="L890"></a><tt class="py-lineno"> 890</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L891"></a><tt class="py-lineno"> 891</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L892"></a><tt class="py-lineno"> 892</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L893"></a><tt class="py-lineno"> 893</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L894"></a><tt class="py-lineno"> 894</tt>  <tt class="py-line"><tt class="py-docstring">    name </tt> </tt>
<a name="L895"></a><tt class="py-lineno"> 895</tt>  <tt class="py-line"><tt class="py-docstring">    The name of the item as it is displayed in the menu itself. </tt> </tt>
<a name="L896"></a><tt class="py-lineno"> 896</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L897"></a><tt class="py-lineno"> 897</tt>  <tt class="py-line"><tt class="py-docstring">    filepath </tt> </tt>
<a name="L898"></a><tt class="py-lineno"> 898</tt>  <tt class="py-line"><tt class="py-docstring">    The full pathname to the associated script file.</tt> </tt>
<a name="L899"></a><tt class="py-lineno"> 899</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L900"></a><tt class="py-lineno"> 900</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L901"></a><tt class="py-lineno"> 901</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-63" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-63', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-64" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-64', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.app.menu.wizard"</tt><tt class="py-op">,</tt>  </tt>
<a name="L902"></a><tt class="py-lineno"> 902</tt>  <tt class="py-line">                                                  <tt id="link-65" class="py-name"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-65', 'index', 'link-55');">index</a></tt><tt class="py-op">)</tt> </tt>
<a name="L903"></a><tt class="py-lineno"> 903</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-66" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-66', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L904"></a><tt class="py-lineno"> 904</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-67" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-67', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-68" class="py-name"><a title="py2ecotect._util._convert_str_to_list" class="py-name" href="#" onclick="return doclink('link-68', '_convert_str_to_list', 'link-58');">_convert_str_to_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt>   </tt>
</div><a name="L905"></a><tt class="py-lineno"> 905</tt>  <tt class="py-line"> </tt>
<a name="set_menu_wizard"></a><div id="set_menu_wizard-def"><a name="L906"></a><tt class="py-lineno"> 906</tt> <a class="py-toggle" href="#" id="set_menu_wizard-toggle" onclick="return toggle('set_menu_wizard');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#set_menu_wizard">set_menu_wizard</a><tt class="py-op">(</tt><tt class="py-param">index</tt><tt class="py-op">,</tt> <tt class="py-param">name_path</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_menu_wizard-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_menu_wizard-expanded"><a name="L907"></a><tt class="py-lineno"> 907</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L908"></a><tt class="py-lineno"> 908</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L909"></a><tt class="py-lineno"> 909</tt>  <tt class="py-line"><tt class="py-docstring">    Set the user-defined wizard at the specified position within the Draw &gt; </tt> </tt>
<a name="L910"></a><tt class="py-lineno"> 910</tt>  <tt class="py-line"><tt class="py-docstring">    Geometry Wizards submenu. Use this command to add a new wizard to the </tt> </tt>
<a name="L911"></a><tt class="py-lineno"> 911</tt>  <tt class="py-line"><tt class="py-docstring">    menu or edit an existing one. </tt> </tt>
<a name="L912"></a><tt class="py-lineno"> 912</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L913"></a><tt class="py-lineno"> 913</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L914"></a><tt class="py-lineno"> 914</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L915"></a><tt class="py-lineno"> 915</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L916"></a><tt class="py-lineno"> 916</tt>  <tt class="py-line"><tt class="py-docstring">    index </tt> </tt>
<a name="L917"></a><tt class="py-lineno"> 917</tt>  <tt class="py-line"><tt class="py-docstring">    An integer value between 1 and 9 representing the index of the wizard </tt> </tt>
<a name="L918"></a><tt class="py-lineno"> 918</tt>  <tt class="py-line"><tt class="py-docstring">    required. </tt> </tt>
<a name="L919"></a><tt class="py-lineno"> 919</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L920"></a><tt class="py-lineno"> 920</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L921"></a><tt class="py-lineno"> 921</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L922"></a><tt class="py-lineno"> 922</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L923"></a><tt class="py-lineno"> 923</tt>  <tt class="py-line"><tt class="py-docstring">    name|path </tt> </tt>
<a name="L924"></a><tt class="py-lineno"> 924</tt>  <tt class="py-line"><tt class="py-docstring">    A text string beginning with the name of the menu item followed by the </tt> </tt>
<a name="L925"></a><tt class="py-lineno"> 925</tt>  <tt class="py-line"><tt class="py-docstring">    full pathname of the associated script file, separated by the '|' </tt> </tt>
<a name="L926"></a><tt class="py-lineno"> 926</tt>  <tt class="py-line"><tt class="py-docstring">    character.</tt> </tt>
<a name="L927"></a><tt class="py-lineno"> 927</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L928"></a><tt class="py-lineno"> 928</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L929"></a><tt class="py-lineno"> 929</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-69" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-69', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-70" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-70', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.app.menu.wizard"</tt><tt class="py-op">,</tt>  </tt>
<a name="L930"></a><tt class="py-lineno"> 930</tt>  <tt class="py-line">                                                  <tt id="link-71" class="py-name"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-71', 'index', 'link-55');">index</a></tt><tt class="py-op">,</tt> <tt class="py-name">name_path</tt><tt class="py-op">)</tt> </tt>
<a name="L931"></a><tt class="py-lineno"> 931</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-72" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-72', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L932"></a><tt class="py-lineno"> 932</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_page"></a><div id="get_page-def"><a name="L933"></a><tt class="py-lineno"> 933</tt> <a class="py-toggle" href="#" id="get_page-toggle" onclick="return toggle('get_page');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#get_page">get_page</a> <tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt>     </tt>
</div><a name="L934"></a><tt class="py-lineno"> 934</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L935"></a><tt class="py-lineno"> 935</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L936"></a><tt class="py-lineno"> 936</tt>  <tt class="py-line"><tt class="py-docstring">    Gets the currently active page in the ECOTECT application window. The </tt> </tt>
<a name="L937"></a><tt class="py-lineno"> 937</tt>  <tt class="py-line"><tt class="py-docstring">    returned value will correspond to one of the items in the following </tt> </tt>
<a name="L938"></a><tt class="py-lineno"> 938</tt>  <tt class="py-line"><tt class="py-docstring">    table. </tt> </tt>
<a name="L939"></a><tt class="py-lineno"> 939</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L940"></a><tt class="py-lineno"> 940</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L941"></a><tt class="py-lineno"> 941</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L942"></a><tt class="py-lineno"> 942</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L943"></a><tt class="py-lineno"> 943</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L944"></a><tt class="py-lineno"> 944</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L945"></a><tt class="py-lineno"> 945</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L946"></a><tt class="py-lineno"> 946</tt>  <tt class="py-line"><tt class="py-docstring">    page </tt> </tt>
<a name="L947"></a><tt class="py-lineno"> 947</tt>  <tt class="py-line"><tt class="py-docstring">    The numerical index of the current application page. </tt> </tt>
<a name="L948"></a><tt class="py-lineno"> 948</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L949"></a><tt class="py-lineno"> 949</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L950"></a><tt class="py-lineno"> 950</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L951"></a><tt class="py-lineno"> 951</tt>  <tt class="py-line"><tt class="py-docstring">    Available Application Pages </tt> </tt>
<a name="L952"></a><tt class="py-lineno"> 952</tt>  <tt class="py-line"><tt class="py-docstring">    ID Description </tt> </tt>
<a name="L953"></a><tt class="py-lineno"> 953</tt>  <tt class="py-line"><tt class="py-docstring">    0 PROJECT Page </tt> </tt>
<a name="L954"></a><tt class="py-lineno"> 954</tt>  <tt class="py-line"><tt class="py-docstring">    1 3D EDITOR Page </tt> </tt>
<a name="L955"></a><tt class="py-lineno"> 955</tt>  <tt class="py-line"><tt class="py-docstring">    2 VISUALISATION Page </tt> </tt>
<a name="L956"></a><tt class="py-lineno"> 956</tt>  <tt class="py-line"><tt class="py-docstring">    3 ANALYSIS Page </tt> </tt>
<a name="L957"></a><tt class="py-lineno"> 957</tt>  <tt class="py-line"><tt class="py-docstring">    4 REPORT Page </tt> </tt>
<a name="L958"></a><tt class="py-lineno"> 958</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L959"></a><tt class="py-lineno"> 959</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L960"></a><tt class="py-lineno"> 960</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-73" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-73', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.app.page"</tt><tt class="py-op">)</tt> </tt>
<a name="L961"></a><tt class="py-lineno"> 961</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-74" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-74', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-75" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-75', '_convert_str_to_type', 'link-45');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">)</tt> </tt>
</div><a name="L962"></a><tt class="py-lineno"> 962</tt>  <tt class="py-line"> </tt>
<a name="set_page"></a><div id="set_page-def"><a name="L963"></a><tt class="py-lineno"> 963</tt> <a class="py-toggle" href="#" id="set_page-toggle" onclick="return toggle('set_page');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#set_page">set_page</a><tt class="py-op">(</tt><tt class="py-param">page</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_page-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_page-expanded"><a name="L964"></a><tt class="py-lineno"> 964</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L965"></a><tt class="py-lineno"> 965</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L966"></a><tt class="py-lineno"> 966</tt>  <tt class="py-line"><tt class="py-docstring">    Sets the currently active page in the ECOTECT application window. These </tt> </tt>
<a name="L967"></a><tt class="py-lineno"> 967</tt>  <tt class="py-line"><tt class="py-docstring">    correspond to the pages with tabs running down the far left side marked </tt> </tt>
<a name="L968"></a><tt class="py-lineno"> 968</tt>  <tt class="py-line"><tt class="py-docstring">    as shown in the following table. </tt> </tt>
<a name="L969"></a><tt class="py-lineno"> 969</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L970"></a><tt class="py-lineno"> 970</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L971"></a><tt class="py-lineno"> 971</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L972"></a><tt class="py-lineno"> 972</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L973"></a><tt class="py-lineno"> 973</tt>  <tt class="py-line"><tt class="py-docstring">    page </tt> </tt>
<a name="L974"></a><tt class="py-lineno"> 974</tt>  <tt class="py-line"><tt class="py-docstring">    The numerical index of the desired application page, as given in the </tt> </tt>
<a name="L975"></a><tt class="py-lineno"> 975</tt>  <tt class="py-line"><tt class="py-docstring">    following table. </tt> </tt>
<a name="L976"></a><tt class="py-lineno"> 976</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L977"></a><tt class="py-lineno"> 977</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L978"></a><tt class="py-lineno"> 978</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L979"></a><tt class="py-lineno"> 979</tt>  <tt class="py-line"><tt class="py-docstring">    Available Application Pages </tt> </tt>
<a name="L980"></a><tt class="py-lineno"> 980</tt>  <tt class="py-line"><tt class="py-docstring">    ID Description </tt> </tt>
<a name="L981"></a><tt class="py-lineno"> 981</tt>  <tt class="py-line"><tt class="py-docstring">    0 PROJECT Page </tt> </tt>
<a name="L982"></a><tt class="py-lineno"> 982</tt>  <tt class="py-line"><tt class="py-docstring">    1 3D EDITOR Page </tt> </tt>
<a name="L983"></a><tt class="py-lineno"> 983</tt>  <tt class="py-line"><tt class="py-docstring">    2 VISUALISATION Page </tt> </tt>
<a name="L984"></a><tt class="py-lineno"> 984</tt>  <tt class="py-line"><tt class="py-docstring">    3 ANALYSIS Page </tt> </tt>
<a name="L985"></a><tt class="py-lineno"> 985</tt>  <tt class="py-line"><tt class="py-docstring">    4 REPORT Page </tt> </tt>
<a name="L986"></a><tt class="py-lineno"> 986</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L987"></a><tt class="py-lineno"> 987</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L988"></a><tt class="py-lineno"> 988</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-76" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-76', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-77" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-77', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.app.page"</tt><tt class="py-op">,</tt> <tt class="py-name">page</tt><tt class="py-op">)</tt> </tt>
<a name="L989"></a><tt class="py-lineno"> 989</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-78" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-78', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L990"></a><tt class="py-lineno"> 990</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_panel"></a><div id="get_panel-def"><a name="L991"></a><tt class="py-lineno"> 991</tt> <a class="py-toggle" href="#" id="get_panel-toggle" onclick="return toggle('get_panel');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#get_panel">get_panel</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt>     </tt>
</div><a name="L992"></a><tt class="py-lineno"> 992</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L993"></a><tt class="py-lineno"> 993</tt>  <tt class="py-line"><tt class="py-docstring">    Gets the currently active panel in the ECOTECT application window. These </tt> </tt>
<a name="L994"></a><tt class="py-lineno"> 994</tt>  <tt class="py-line"><tt class="py-docstring">    correspond to the tabbed panels on the right hand side of the window, as </tt> </tt>
<a name="L995"></a><tt class="py-lineno"> 995</tt>  <tt class="py-line"><tt class="py-docstring">    shown in the following table. Getting this value returns the integer </tt> </tt>
<a name="L996"></a><tt class="py-lineno"> 996</tt>  <tt class="py-line"><tt class="py-docstring">    value corresponding to each item in the table. </tt> </tt>
<a name="L997"></a><tt class="py-lineno"> 997</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L998"></a><tt class="py-lineno"> 998</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L999"></a><tt class="py-lineno"> 999</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L1000"></a><tt class="py-lineno">1000</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1001"></a><tt class="py-lineno">1001</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L1002"></a><tt class="py-lineno">1002</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L1003"></a><tt class="py-lineno">1003</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1004"></a><tt class="py-lineno">1004</tt>  <tt class="py-line"><tt class="py-docstring">    panel </tt> </tt>
<a name="L1005"></a><tt class="py-lineno">1005</tt>  <tt class="py-line"><tt class="py-docstring">    The numerical index of the current application panel. </tt> </tt>
<a name="L1006"></a><tt class="py-lineno">1006</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1007"></a><tt class="py-lineno">1007</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L1008"></a><tt class="py-lineno">1008</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1009"></a><tt class="py-lineno">1009</tt>  <tt class="py-line"><tt class="py-docstring">    Available Application Panels </tt> </tt>
<a name="L1010"></a><tt class="py-lineno">1010</tt>  <tt class="py-line"><tt class="py-docstring">    ID Description </tt> </tt>
<a name="L1011"></a><tt class="py-lineno">1011</tt>  <tt class="py-line"><tt class="py-docstring">    0 Selection Information </tt> </tt>
<a name="L1012"></a><tt class="py-lineno">1012</tt>  <tt class="py-line"><tt class="py-docstring">    1 Zone Management </tt> </tt>
<a name="L1013"></a><tt class="py-lineno">1013</tt>  <tt class="py-line"><tt class="py-docstring">    2 Material Assignments </tt> </tt>
<a name="L1014"></a><tt class="py-lineno">1014</tt>  <tt class="py-line"><tt class="py-docstring">    3 Display Settings </tt> </tt>
<a name="L1015"></a><tt class="py-lineno">1015</tt>  <tt class="py-line"><tt class="py-docstring">    4 Visualisation Settings </tt> </tt>
<a name="L1016"></a><tt class="py-lineno">1016</tt>  <tt class="py-line"><tt class="py-docstring">    5 Shadow Settings </tt> </tt>
<a name="L1017"></a><tt class="py-lineno">1017</tt>  <tt class="py-line"><tt class="py-docstring">    6 Analysis Grid </tt> </tt>
<a name="L1018"></a><tt class="py-lineno">1018</tt>  <tt class="py-line"><tt class="py-docstring">    7 Rays and Particles </tt> </tt>
<a name="L1019"></a><tt class="py-lineno">1019</tt>  <tt class="py-line"><tt class="py-docstring">    8 Scripts and Wizards </tt> </tt>
<a name="L1020"></a><tt class="py-lineno">1020</tt>  <tt class="py-line"><tt class="py-docstring">    9 Object Transformation </tt> </tt>
<a name="L1021"></a><tt class="py-lineno">1021</tt>  <tt class="py-line"><tt class="py-docstring">    10 Export Manager </tt> </tt>
<a name="L1022"></a><tt class="py-lineno">1022</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1023"></a><tt class="py-lineno">1023</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L1024"></a><tt class="py-lineno">1024</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-79" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-79', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.app.panel"</tt><tt class="py-op">)</tt> </tt>
<a name="L1025"></a><tt class="py-lineno">1025</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-80" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-80', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-81" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-81', '_convert_str_to_type', 'link-45');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1026"></a><tt class="py-lineno">1026</tt>  <tt class="py-line"> </tt>
<a name="set_panel"></a><div id="set_panel-def"><a name="L1027"></a><tt class="py-lineno">1027</tt> <a class="py-toggle" href="#" id="set_panel-toggle" onclick="return toggle('set_panel');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#set_panel">set_panel</a><tt class="py-op">(</tt><tt class="py-param">panel</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_panel-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_panel-expanded"><a name="L1028"></a><tt class="py-lineno">1028</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L1029"></a><tt class="py-lineno">1029</tt>  <tt class="py-line"><tt class="py-docstring">    Sets the currently active panel in the ECOTECT application window. These </tt> </tt>
<a name="L1030"></a><tt class="py-lineno">1030</tt>  <tt class="py-line"><tt class="py-docstring">    correspond to the tabbed panels on the right hand side of the window, </tt> </tt>
<a name="L1031"></a><tt class="py-lineno">1031</tt>  <tt class="py-line"><tt class="py-docstring">    as shown in the following table. </tt> </tt>
<a name="L1032"></a><tt class="py-lineno">1032</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1033"></a><tt class="py-lineno">1033</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L1034"></a><tt class="py-lineno">1034</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L1035"></a><tt class="py-lineno">1035</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1036"></a><tt class="py-lineno">1036</tt>  <tt class="py-line"><tt class="py-docstring">    panel </tt> </tt>
<a name="L1037"></a><tt class="py-lineno">1037</tt>  <tt class="py-line"><tt class="py-docstring">    Either a string containing the panel token or the numerical index of the </tt> </tt>
<a name="L1038"></a><tt class="py-lineno">1038</tt>  <tt class="py-line"><tt class="py-docstring">    desired application panel. </tt> </tt>
<a name="L1039"></a><tt class="py-lineno">1039</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1040"></a><tt class="py-lineno">1040</tt>  <tt class="py-line"><tt class="py-docstring">    Relevant Data Table(s)</tt> </tt>
<a name="L1041"></a><tt class="py-lineno">1041</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1042"></a><tt class="py-lineno">1042</tt>  <tt class="py-line"><tt class="py-docstring">    Available Application </tt> </tt>
<a name="L1043"></a><tt class="py-lineno">1043</tt>  <tt class="py-line"><tt class="py-docstring">    Panels ID Description </tt> </tt>
<a name="L1044"></a><tt class="py-lineno">1044</tt>  <tt class="py-line"><tt class="py-docstring">    0 Selection Information </tt> </tt>
<a name="L1045"></a><tt class="py-lineno">1045</tt>  <tt class="py-line"><tt class="py-docstring">    1 Zone Management </tt> </tt>
<a name="L1046"></a><tt class="py-lineno">1046</tt>  <tt class="py-line"><tt class="py-docstring">    2 Material Assignments </tt> </tt>
<a name="L1047"></a><tt class="py-lineno">1047</tt>  <tt class="py-line"><tt class="py-docstring">    3 Display Settings </tt> </tt>
<a name="L1048"></a><tt class="py-lineno">1048</tt>  <tt class="py-line"><tt class="py-docstring">    4 Visualisation Settings </tt> </tt>
<a name="L1049"></a><tt class="py-lineno">1049</tt>  <tt class="py-line"><tt class="py-docstring">    5 Shadow Settings </tt> </tt>
<a name="L1050"></a><tt class="py-lineno">1050</tt>  <tt class="py-line"><tt class="py-docstring">    6 Analysis Grid </tt> </tt>
<a name="L1051"></a><tt class="py-lineno">1051</tt>  <tt class="py-line"><tt class="py-docstring">    7 Rays and Particles </tt> </tt>
<a name="L1052"></a><tt class="py-lineno">1052</tt>  <tt class="py-line"><tt class="py-docstring">    8 Scripts and Wizards </tt> </tt>
<a name="L1053"></a><tt class="py-lineno">1053</tt>  <tt class="py-line"><tt class="py-docstring">    9 Object Transformation </tt> </tt>
<a name="L1054"></a><tt class="py-lineno">1054</tt>  <tt class="py-line"><tt class="py-docstring">    10 Export Manager </tt> </tt>
<a name="L1055"></a><tt class="py-lineno">1055</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1056"></a><tt class="py-lineno">1056</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L1057"></a><tt class="py-lineno">1057</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-82" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-82', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-83" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-83', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.app.panel"</tt><tt class="py-op">,</tt> <tt class="py-name">panel</tt><tt class="py-op">)</tt> </tt>
<a name="L1058"></a><tt class="py-lineno">1058</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-84" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-84', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1059"></a><tt class="py-lineno">1059</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="path"></a><div id="path-def"><a name="L1060"></a><tt class="py-lineno">1060</tt> <a class="py-toggle" href="#" id="path-toggle" onclick="return toggle('path');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#path">path</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt>    </tt>
</div><a name="L1061"></a><tt class="py-lineno">1061</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L1062"></a><tt class="py-lineno">1062</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1063"></a><tt class="py-lineno">1063</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns a single text string containing the </tt> </tt>
<a name="L1064"></a><tt class="py-lineno">1064</tt>  <tt class="py-line"><tt class="py-docstring">    installation home directory of the ECOTECT application which, by </tt> </tt>
<a name="L1065"></a><tt class="py-lineno">1065</tt>  <tt class="py-line"><tt class="py-docstring">    default, is usually 'C:\Program Files\Square One'. This can be useful </tt> </tt>
<a name="L1066"></a><tt class="py-lineno">1066</tt>  <tt class="py-line"><tt class="py-docstring">    if you need to locate example or tutorial files in your script. This </tt> </tt>
<a name="L1067"></a><tt class="py-lineno">1067</tt>  <tt class="py-line"><tt class="py-docstring">    property is read only. </tt> </tt>
<a name="L1068"></a><tt class="py-lineno">1068</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1069"></a><tt class="py-lineno">1069</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L1070"></a><tt class="py-lineno">1070</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L1071"></a><tt class="py-lineno">1071</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1072"></a><tt class="py-lineno">1072</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L1073"></a><tt class="py-lineno">1073</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L1074"></a><tt class="py-lineno">1074</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1075"></a><tt class="py-lineno">1075</tt>  <tt class="py-line"><tt class="py-docstring">    path </tt> </tt>
<a name="L1076"></a><tt class="py-lineno">1076</tt>  <tt class="py-line"><tt class="py-docstring">    A text string containing the full home directory path.</tt> </tt>
<a name="L1077"></a><tt class="py-lineno">1077</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1078"></a><tt class="py-lineno">1078</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L1079"></a><tt class="py-lineno">1079</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-85" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-85', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.app.path"</tt><tt class="py-op">)</tt> </tt>
<a name="L1080"></a><tt class="py-lineno">1080</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-86" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-86', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-87" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-87', '_convert_str_to_type', 'link-45');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1081"></a><tt class="py-lineno">1081</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_registry"></a><div id="get_registry-def"><a name="L1082"></a><tt class="py-lineno">1082</tt> <a class="py-toggle" href="#" id="get_registry-toggle" onclick="return toggle('get_registry');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#get_registry">get_registry</a><tt class="py-op">(</tt><tt class="py-param">key</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_registry-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_registry-expanded"><a name="L1083"></a><tt class="py-lineno">1083</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L1084"></a><tt class="py-lineno">1084</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1085"></a><tt class="py-lineno">1085</tt>  <tt class="py-line"><tt class="py-docstring">    Use this property to retrieve values from the application's entry within </tt> </tt>
<a name="L1086"></a><tt class="py-lineno">1086</tt>  <tt class="py-line"><tt class="py-docstring">    the Windows registry. Such values are stored on a per-user basic and </tt> </tt>
<a name="L1087"></a><tt class="py-lineno">1087</tt>  <tt class="py-line"><tt class="py-docstring">    this property only allows access to values local to this application. In </tt> </tt>
<a name="L1088"></a><tt class="py-lineno">1088</tt>  <tt class="py-line"><tt class="py-docstring">    ECOTECT, for example, this is located at </tt> </tt>
<a name="L1089"></a><tt class="py-lineno">1089</tt>  <tt class="py-line"><tt class="py-docstring">    HKEY_CURRENT_USER\Software\Square One\Ecotect\5.60. Registry entries are </tt> </tt>
<a name="L1090"></a><tt class="py-lineno">1090</tt>  <tt class="py-line"><tt class="py-docstring">    stored as a series of parameters in the form 'key=value'. </tt> </tt>
<a name="L1091"></a><tt class="py-lineno">1091</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1092"></a><tt class="py-lineno">1092</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L1093"></a><tt class="py-lineno">1093</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L1094"></a><tt class="py-lineno">1094</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1095"></a><tt class="py-lineno">1095</tt>  <tt class="py-line"><tt class="py-docstring">    key </tt> </tt>
<a name="L1096"></a><tt class="py-lineno">1096</tt>  <tt class="py-line"><tt class="py-docstring">    The name of an existing key stored in the application's registry entry.</tt> </tt>
<a name="L1097"></a><tt class="py-lineno">1097</tt>  <tt class="py-line"><tt class="py-docstring">     </tt> </tt>
<a name="L1098"></a><tt class="py-lineno">1098</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L1099"></a><tt class="py-lineno">1099</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L1100"></a><tt class="py-lineno">1100</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1101"></a><tt class="py-lineno">1101</tt>  <tt class="py-line"><tt class="py-docstring">    value </tt> </tt>
<a name="L1102"></a><tt class="py-lineno">1102</tt>  <tt class="py-line"><tt class="py-docstring">    A text string containing the value, if any, associated with the given </tt> </tt>
<a name="L1103"></a><tt class="py-lineno">1103</tt>  <tt class="py-line"><tt class="py-docstring">    key.</tt> </tt>
<a name="L1104"></a><tt class="py-lineno">1104</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1105"></a><tt class="py-lineno">1105</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L1106"></a><tt class="py-lineno">1106</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-88" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-88', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-89" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-89', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.app.registry"</tt><tt class="py-op">,</tt> <tt id="link-90" class="py-name" targets="Function py2ecotect.app.application.key()=py2ecotect.app.application-module.html#key"><a title="py2ecotect.app.application.key" class="py-name" href="#" onclick="return doclink('link-90', 'key', 'link-90');">key</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1107"></a><tt class="py-lineno">1107</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-91" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-91', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L1108"></a><tt class="py-lineno">1108</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-92" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-92', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-93" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-93', '_convert_str_to_type', 'link-45');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1109"></a><tt class="py-lineno">1109</tt>  <tt class="py-line"> </tt>
<a name="set_registry"></a><div id="set_registry-def"><a name="L1110"></a><tt class="py-lineno">1110</tt> <a class="py-toggle" href="#" id="set_registry-toggle" onclick="return toggle('set_registry');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#set_registry">set_registry</a><tt class="py-op">(</tt><tt class="py-param">keyvalue</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_registry-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_registry-expanded"><a name="L1111"></a><tt class="py-lineno">1111</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L1112"></a><tt class="py-lineno">1112</tt>  <tt class="py-line"><tt class="py-docstring">    Use this property to set a value in the application's Windows registry </tt> </tt>
<a name="L1113"></a><tt class="py-lineno">1113</tt>  <tt class="py-line"><tt class="py-docstring">    entry. Such values are stored on a per-user basic and this property only </tt> </tt>
<a name="L1114"></a><tt class="py-lineno">1114</tt>  <tt class="py-line"><tt class="py-docstring">    allows access to values local to this application. In ECOTECT, for </tt> </tt>
<a name="L1115"></a><tt class="py-lineno">1115</tt>  <tt class="py-line"><tt class="py-docstring">    example, this is located at </tt> </tt>
<a name="L1116"></a><tt class="py-lineno">1116</tt>  <tt class="py-line"><tt class="py-docstring">    HKEY_CURRENT_USER\Software\Square One\Ecotect\5.60. Registry entries are </tt> </tt>
<a name="L1117"></a><tt class="py-lineno">1117</tt>  <tt class="py-line"><tt class="py-docstring">    stored as a series of parameters in the form 'key=value'. </tt> </tt>
<a name="L1118"></a><tt class="py-lineno">1118</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1119"></a><tt class="py-lineno">1119</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L1120"></a><tt class="py-lineno">1120</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L1121"></a><tt class="py-lineno">1121</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1122"></a><tt class="py-lineno">1122</tt>  <tt class="py-line"><tt class="py-docstring">    key=value </tt> </tt>
<a name="L1123"></a><tt class="py-lineno">1123</tt>  <tt class="py-line"><tt class="py-docstring">    To set a value, you must include both the key name and the value to be </tt> </tt>
<a name="L1124"></a><tt class="py-lineno">1124</tt>  <tt class="py-line"><tt class="py-docstring">    set, separated by an equal '=' character. </tt> </tt>
<a name="L1125"></a><tt class="py-lineno">1125</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1126"></a><tt class="py-lineno">1126</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L1127"></a><tt class="py-lineno">1127</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-94" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-94', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-95" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-95', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.app.registry"</tt><tt class="py-op">,</tt>  </tt>
<a name="L1128"></a><tt class="py-lineno">1128</tt>  <tt class="py-line">                                                  <tt class="py-name">keyvalue</tt><tt class="py-op">)</tt> </tt>
<a name="L1129"></a><tt class="py-lineno">1129</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-96" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-96', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1130"></a><tt class="py-lineno">1130</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_screen"></a><div id="get_screen-def"><a name="L1131"></a><tt class="py-lineno">1131</tt> <a class="py-toggle" href="#" id="get_screen-toggle" onclick="return toggle('get_screen');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#get_screen">get_screen</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt>     </tt>
</div><a name="L1132"></a><tt class="py-lineno">1132</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L1133"></a><tt class="py-lineno">1133</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1134"></a><tt class="py-lineno">1134</tt>  <tt class="py-line"><tt class="py-docstring">    Retrieve the position and size of the main Windows screen area. </tt> </tt>
<a name="L1135"></a><tt class="py-lineno">1135</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1136"></a><tt class="py-lineno">1136</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L1137"></a><tt class="py-lineno">1137</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L1138"></a><tt class="py-lineno">1138</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1139"></a><tt class="py-lineno">1139</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L1140"></a><tt class="py-lineno">1140</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L1141"></a><tt class="py-lineno">1141</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1142"></a><tt class="py-lineno">1142</tt>  <tt class="py-line"><tt class="py-docstring">    left </tt> </tt>
<a name="L1143"></a><tt class="py-lineno">1143</tt>  <tt class="py-line"><tt class="py-docstring">    The position of the left side of the screen in pixels.</tt> </tt>
<a name="L1144"></a><tt class="py-lineno">1144</tt>  <tt class="py-line"><tt class="py-docstring">     </tt> </tt>
<a name="L1145"></a><tt class="py-lineno">1145</tt>  <tt class="py-line"><tt class="py-docstring">    top </tt> </tt>
<a name="L1146"></a><tt class="py-lineno">1146</tt>  <tt class="py-line"><tt class="py-docstring">    The position of the top side of the screen in pixels.</tt> </tt>
<a name="L1147"></a><tt class="py-lineno">1147</tt>  <tt class="py-line"><tt class="py-docstring">     </tt> </tt>
<a name="L1148"></a><tt class="py-lineno">1148</tt>  <tt class="py-line"><tt class="py-docstring">    width </tt> </tt>
<a name="L1149"></a><tt class="py-lineno">1149</tt>  <tt class="py-line"><tt class="py-docstring">    The horizontal width of the screen in pixels.</tt> </tt>
<a name="L1150"></a><tt class="py-lineno">1150</tt>  <tt class="py-line"><tt class="py-docstring">     </tt> </tt>
<a name="L1151"></a><tt class="py-lineno">1151</tt>  <tt class="py-line"><tt class="py-docstring">    height </tt> </tt>
<a name="L1152"></a><tt class="py-lineno">1152</tt>  <tt class="py-line"><tt class="py-docstring">    The vertical height of the screen in pixels.</tt> </tt>
<a name="L1153"></a><tt class="py-lineno">1153</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1154"></a><tt class="py-lineno">1154</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L1155"></a><tt class="py-lineno">1155</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-97" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-97', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.app.screen"</tt><tt class="py-op">)</tt> </tt>
<a name="L1156"></a><tt class="py-lineno">1156</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-98" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-98', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-99" class="py-name"><a title="py2ecotect._util._convert_str_to_list" class="py-name" href="#" onclick="return doclink('link-99', '_convert_str_to_list', 'link-58');">_convert_str_to_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">)</tt>  </tt>
</div><a name="L1157"></a><tt class="py-lineno">1157</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_slider_range"></a><div id="get_slider_range-def"><a name="L1158"></a><tt class="py-lineno">1158</tt> <a class="py-toggle" href="#" id="get_slider_range-toggle" onclick="return toggle('get_slider_range');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#get_slider_range">get_slider_range</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_slider_range-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_slider_range-expanded"><a name="L1159"></a><tt class="py-lineno">1159</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L1160"></a><tt class="py-lineno">1160</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1161"></a><tt class="py-lineno">1161</tt>  <tt class="py-line"><tt class="py-docstring">    Retrieves the range of the main slider. The range defines the minimum </tt> </tt>
<a name="L1162"></a><tt class="py-lineno">1162</tt>  <tt class="py-line"><tt class="py-docstring">    and maximum values over which the slider moves as well as other settings </tt> </tt>
<a name="L1163"></a><tt class="py-lineno">1163</tt>  <tt class="py-line"><tt class="py-docstring">    such as the increment/decrement when using the arrow and PageUp/PageDown </tt> </tt>
<a name="L1164"></a><tt class="py-lineno">1164</tt>  <tt class="py-line"><tt class="py-docstring">    keys. </tt> </tt>
<a name="L1165"></a><tt class="py-lineno">1165</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1166"></a><tt class="py-lineno">1166</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L1167"></a><tt class="py-lineno">1167</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L1168"></a><tt class="py-lineno">1168</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1169"></a><tt class="py-lineno">1169</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L1170"></a><tt class="py-lineno">1170</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L1171"></a><tt class="py-lineno">1171</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1172"></a><tt class="py-lineno">1172</tt>  <tt class="py-line"><tt class="py-docstring">    min </tt> </tt>
<a name="L1173"></a><tt class="py-lineno">1173</tt>  <tt class="py-line"><tt class="py-docstring">    The value when the slider is at its minimum.</tt> </tt>
<a name="L1174"></a><tt class="py-lineno">1174</tt>  <tt class="py-line"><tt class="py-docstring">     </tt> </tt>
<a name="L1175"></a><tt class="py-lineno">1175</tt>  <tt class="py-line"><tt class="py-docstring">    max </tt> </tt>
<a name="L1176"></a><tt class="py-lineno">1176</tt>  <tt class="py-line"><tt class="py-docstring">    The value when the slider is at its maximum.</tt> </tt>
<a name="L1177"></a><tt class="py-lineno">1177</tt>  <tt class="py-line"><tt class="py-docstring">     </tt> </tt>
<a name="L1178"></a><tt class="py-lineno">1178</tt>  <tt class="py-line"><tt class="py-docstring">    freq </tt> </tt>
<a name="L1179"></a><tt class="py-lineno">1179</tt>  <tt class="py-line"><tt class="py-docstring">    The frequency of indicator marks running along the bottom.</tt> </tt>
<a name="L1180"></a><tt class="py-lineno">1180</tt>  <tt class="py-line"><tt class="py-docstring">     </tt> </tt>
<a name="L1181"></a><tt class="py-lineno">1181</tt>  <tt class="py-line"><tt class="py-docstring">    lineSize </tt> </tt>
<a name="L1182"></a><tt class="py-lineno">1182</tt>  <tt class="py-line"><tt class="py-docstring">    The increment/decrement value when using the arrow keys.</tt> </tt>
<a name="L1183"></a><tt class="py-lineno">1183</tt>  <tt class="py-line"><tt class="py-docstring">     </tt> </tt>
<a name="L1184"></a><tt class="py-lineno">1184</tt>  <tt class="py-line"><tt class="py-docstring">    pageSize </tt> </tt>
<a name="L1185"></a><tt class="py-lineno">1185</tt>  <tt class="py-line"><tt class="py-docstring">    The increment/decrement value when using the PageUp/PageDown keys. </tt> </tt>
<a name="L1186"></a><tt class="py-lineno">1186</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1187"></a><tt class="py-lineno">1187</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L1188"></a><tt class="py-lineno">1188</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-100" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-100', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.app.slider.range"</tt><tt class="py-op">)</tt> </tt>
<a name="L1189"></a><tt class="py-lineno">1189</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-101" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-101', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-102" class="py-name"><a title="py2ecotect._util._convert_str_to_list" class="py-name" href="#" onclick="return doclink('link-102', '_convert_str_to_list', 'link-58');">_convert_str_to_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">)</tt>   </tt>
</div><a name="L1190"></a><tt class="py-lineno">1190</tt>  <tt class="py-line"> </tt>
<a name="set_slider_range"></a><div id="set_slider_range-def"><a name="L1191"></a><tt class="py-lineno">1191</tt> <a class="py-toggle" href="#" id="set_slider_range-toggle" onclick="return toggle('set_slider_range');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#set_slider_range">set_slider_range</a><tt class="py-op">(</tt><tt class="py-param">min</tt><tt class="py-op">,</tt> <tt class="py-param">max</tt><tt class="py-op">,</tt> <tt class="py-param">freq</tt><tt class="py-op">,</tt> <tt class="py-param">lineSize</tt><tt class="py-op">,</tt> <tt class="py-param">pageSize</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_slider_range-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_slider_range-expanded"><a name="L1192"></a><tt class="py-lineno">1192</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L1193"></a><tt class="py-lineno">1193</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1194"></a><tt class="py-lineno">1194</tt>  <tt class="py-line"><tt class="py-docstring">    Sets the range of the main slider. The range defines the minimum and </tt> </tt>
<a name="L1195"></a><tt class="py-lineno">1195</tt>  <tt class="py-line"><tt class="py-docstring">    maximum values over which the slider moves as well as other settings </tt> </tt>
<a name="L1196"></a><tt class="py-lineno">1196</tt>  <tt class="py-line"><tt class="py-docstring">    such as the increment/decrement when using the arrow and PageUp/PageDown </tt> </tt>
<a name="L1197"></a><tt class="py-lineno">1197</tt>  <tt class="py-line"><tt class="py-docstring">    keys. </tt> </tt>
<a name="L1198"></a><tt class="py-lineno">1198</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1199"></a><tt class="py-lineno">1199</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L1200"></a><tt class="py-lineno">1200</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L1201"></a><tt class="py-lineno">1201</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1202"></a><tt class="py-lineno">1202</tt>  <tt class="py-line"><tt class="py-docstring">    min </tt> </tt>
<a name="L1203"></a><tt class="py-lineno">1203</tt>  <tt class="py-line"><tt class="py-docstring">    The value when the slider is at its minimum. This value can be set to </tt> </tt>
<a name="L1204"></a><tt class="py-lineno">1204</tt>  <tt class="py-line"><tt class="py-docstring">    anything as long as it is less than the 'max' parameter. </tt> </tt>
<a name="L1205"></a><tt class="py-lineno">1205</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1206"></a><tt class="py-lineno">1206</tt>  <tt class="py-line"><tt class="py-docstring">    max </tt> </tt>
<a name="L1207"></a><tt class="py-lineno">1207</tt>  <tt class="py-line"><tt class="py-docstring">    The value when the slider is at its maximum. This value can be set to </tt> </tt>
<a name="L1208"></a><tt class="py-lineno">1208</tt>  <tt class="py-line"><tt class="py-docstring">    anything as long as it is greater than the 'min' parameter. </tt> </tt>
<a name="L1209"></a><tt class="py-lineno">1209</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1210"></a><tt class="py-lineno">1210</tt>  <tt class="py-line"><tt class="py-docstring">    freq </tt> </tt>
<a name="L1211"></a><tt class="py-lineno">1211</tt>  <tt class="py-line"><tt class="py-docstring">    The frequency of indicator marks running along the bottom. If this value </tt> </tt>
<a name="L1212"></a><tt class="py-lineno">1212</tt>  <tt class="py-line"><tt class="py-docstring">    is set to zero (0) or less, it is ignored and the currently set value is </tt> </tt>
<a name="L1213"></a><tt class="py-lineno">1213</tt>  <tt class="py-line"><tt class="py-docstring">    used. </tt> </tt>
<a name="L1214"></a><tt class="py-lineno">1214</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1215"></a><tt class="py-lineno">1215</tt>  <tt class="py-line"><tt class="py-docstring">    lineSize </tt> </tt>
<a name="L1216"></a><tt class="py-lineno">1216</tt>  <tt class="py-line"><tt class="py-docstring">    The increment/decrement value when using the arrow keys. If this value </tt> </tt>
<a name="L1217"></a><tt class="py-lineno">1217</tt>  <tt class="py-line"><tt class="py-docstring">    is set to zero (0) or less, it is ignored and the currently set value is </tt> </tt>
<a name="L1218"></a><tt class="py-lineno">1218</tt>  <tt class="py-line"><tt class="py-docstring">    used. </tt> </tt>
<a name="L1219"></a><tt class="py-lineno">1219</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1220"></a><tt class="py-lineno">1220</tt>  <tt class="py-line"><tt class="py-docstring">    pageSize </tt> </tt>
<a name="L1221"></a><tt class="py-lineno">1221</tt>  <tt class="py-line"><tt class="py-docstring">    The increment/decrement value when using the PageUp/PageDown keys. If </tt> </tt>
<a name="L1222"></a><tt class="py-lineno">1222</tt>  <tt class="py-line"><tt class="py-docstring">    this value is set to zero (0) or less, it is ignored and the currently </tt> </tt>
<a name="L1223"></a><tt class="py-lineno">1223</tt>  <tt class="py-line"><tt class="py-docstring">    set value is used. </tt> </tt>
<a name="L1224"></a><tt class="py-lineno">1224</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1225"></a><tt class="py-lineno">1225</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L1226"></a><tt class="py-lineno">1226</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-103" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-103', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-104" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-104', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.app.slider.range"</tt><tt class="py-op">,</tt>  </tt>
<a name="L1227"></a><tt class="py-lineno">1227</tt>  <tt class="py-line">                                                 <tt class="py-name">min</tt><tt class="py-op">,</tt> <tt class="py-name">max</tt><tt class="py-op">,</tt> <tt class="py-name">freq</tt><tt class="py-op">,</tt> <tt class="py-name">lineSize</tt><tt class="py-op">,</tt>  </tt>
<a name="L1228"></a><tt class="py-lineno">1228</tt>  <tt class="py-line">                                                 <tt class="py-name">pageSize</tt><tt class="py-op">)</tt> </tt>
<a name="L1229"></a><tt class="py-lineno">1229</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-105" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-105', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1230"></a><tt class="py-lineno">1230</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_slider_scale"></a><div id="get_slider_scale-def"><a name="L1231"></a><tt class="py-lineno">1231</tt> <a class="py-toggle" href="#" id="get_slider_scale-toggle" onclick="return toggle('get_slider_scale');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#get_slider_scale">get_slider_scale</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_slider_scale-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_slider_scale-expanded"><a name="L1232"></a><tt class="py-lineno">1232</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L1233"></a><tt class="py-lineno">1233</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1234"></a><tt class="py-lineno">1234</tt>  <tt class="py-line"><tt class="py-docstring">    Retrieves the current scale factor for the main slider and the </tt> </tt>
<a name="L1235"></a><tt class="py-lineno">1235</tt>  <tt class="py-line"><tt class="py-docstring">    hover-over hint if it is set. </tt> </tt>
<a name="L1236"></a><tt class="py-lineno">1236</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1237"></a><tt class="py-lineno">1237</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L1238"></a><tt class="py-lineno">1238</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L1239"></a><tt class="py-lineno">1239</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1240"></a><tt class="py-lineno">1240</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L1241"></a><tt class="py-lineno">1241</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L1242"></a><tt class="py-lineno">1242</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1243"></a><tt class="py-lineno">1243</tt>  <tt class="py-line"><tt class="py-docstring">    scale </tt> </tt>
<a name="L1244"></a><tt class="py-lineno">1244</tt>  <tt class="py-line"><tt class="py-docstring">    This scale factor is used to convert the range specfied in the </tt> </tt>
<a name="L1245"></a><tt class="py-lineno">1245</tt>  <tt class="py-line"><tt class="py-docstring">    app.slider.range setting to a user-readable value </tt> </tt>
<a name="L1246"></a><tt class="py-lineno">1246</tt>  <tt class="py-line"><tt class="py-docstring">    (see set.app.slider.scale). </tt> </tt>
<a name="L1247"></a><tt class="py-lineno">1247</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1248"></a><tt class="py-lineno">1248</tt>  <tt class="py-line"><tt class="py-docstring">    [hint] </tt> </tt>
<a name="L1249"></a><tt class="py-lineno">1249</tt>  <tt class="py-line"><tt class="py-docstring">    This is the popup hint you see when you move the mouse over the top of </tt> </tt>
<a name="L1250"></a><tt class="py-lineno">1250</tt>  <tt class="py-line"><tt class="py-docstring">    the slider.</tt> </tt>
<a name="L1251"></a><tt class="py-lineno">1251</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1252"></a><tt class="py-lineno">1252</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt>     </tt>
<a name="L1253"></a><tt class="py-lineno">1253</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-106" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-106', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.app.slider.scale"</tt><tt class="py-op">)</tt> </tt>
<a name="L1254"></a><tt class="py-lineno">1254</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-107" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-107', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-108" class="py-name"><a title="py2ecotect._util._convert_str_to_list" class="py-name" href="#" onclick="return doclink('link-108', '_convert_str_to_list', 'link-58');">_convert_str_to_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1255"></a><tt class="py-lineno">1255</tt>  <tt class="py-line">     </tt>
<a name="set_slider_scale"></a><div id="set_slider_scale-def"><a name="L1256"></a><tt class="py-lineno">1256</tt> <a class="py-toggle" href="#" id="set_slider_scale-toggle" onclick="return toggle('set_slider_scale');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#set_slider_scale">set_slider_scale</a><tt class="py-op">(</tt><tt class="py-param">scale</tt><tt class="py-op">,</tt> <tt class="py-param">hint</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_slider_scale-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_slider_scale-expanded"><a name="L1257"></a><tt class="py-lineno">1257</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L1258"></a><tt class="py-lineno">1258</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1259"></a><tt class="py-lineno">1259</tt>  <tt class="py-line"><tt class="py-docstring">    Sets the scale factor for the main slider and, optionally, the </tt> </tt>
<a name="L1260"></a><tt class="py-lineno">1260</tt>  <tt class="py-line"><tt class="py-docstring">    hover-over hint value. </tt> </tt>
<a name="L1261"></a><tt class="py-lineno">1261</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1262"></a><tt class="py-lineno">1262</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L1263"></a><tt class="py-lineno">1263</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L1264"></a><tt class="py-lineno">1264</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1265"></a><tt class="py-lineno">1265</tt>  <tt class="py-line"><tt class="py-docstring">    scale </tt> </tt>
<a name="L1266"></a><tt class="py-lineno">1266</tt>  <tt class="py-line"><tt class="py-docstring">    This scale factor is used to convert the range specfied in the </tt> </tt>
<a name="L1267"></a><tt class="py-lineno">1267</tt>  <tt class="py-line"><tt class="py-docstring">    app.slider.range setting to a user-readable value. For example, you may </tt> </tt>
<a name="L1268"></a><tt class="py-lineno">1268</tt>  <tt class="py-line"><tt class="py-docstring">    want to display values in percent, but want higher accuracy on the </tt> </tt>
<a name="L1269"></a><tt class="py-lineno">1269</tt>  <tt class="py-line"><tt class="py-docstring">    slider values. In this case, you can set range.min=0, range.max=1000, </tt> </tt>
<a name="L1270"></a><tt class="py-lineno">1270</tt>  <tt class="py-line"><tt class="py-docstring">    range.freq=1 and then the scale to 0.1. </tt> </tt>
<a name="L1271"></a><tt class="py-lineno">1271</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1272"></a><tt class="py-lineno">1272</tt>  <tt class="py-line"><tt class="py-docstring">    [hint] </tt> </tt>
<a name="L1273"></a><tt class="py-lineno">1273</tt>  <tt class="py-line"><tt class="py-docstring">    By including this optional value, you can set the hover-over hint for </tt> </tt>
<a name="L1274"></a><tt class="py-lineno">1274</tt>  <tt class="py-line"><tt class="py-docstring">    the slider when you move the mouse over the top of it.</tt> </tt>
<a name="L1275"></a><tt class="py-lineno">1275</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1276"></a><tt class="py-lineno">1276</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt>     </tt>
<a name="L1277"></a><tt class="py-lineno">1277</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-109" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-109', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-110" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-110', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.app.slider.scale"</tt><tt class="py-op">,</tt>  </tt>
<a name="L1278"></a><tt class="py-lineno">1278</tt>  <tt class="py-line">                                                  <tt id="link-111" class="py-name" targets="Variable py2ecotect.app.radiance.Radiance.scale=py2ecotect.app.radiance.Radiance-class.html#scale,Method py2ecotect.doc.selection.Selection.scale()=py2ecotect.doc.selection.Selection-class.html#scale,Method py2ecotect.ent.zone.Zone.scale()=py2ecotect.ent.zone.Zone-class.html#scale,Method py2ecotect.obj._node.Node.scale()=py2ecotect.obj._node.Node-class.html#scale,Method py2ecotect.obj._object._ObjectRootTrfm.scale()=py2ecotect.obj._object._ObjectRootTrfm-class.html#scale"><a title="py2ecotect.app.radiance.Radiance.scale
py2ecotect.doc.selection.Selection.scale
py2ecotect.ent.zone.Zone.scale
py2ecotect.obj._node.Node.scale
py2ecotect.obj._object._ObjectRootTrfm.scale" class="py-name" href="#" onclick="return doclink('link-111', 'scale', 'link-111');">scale</a></tt><tt class="py-op">,</tt> <tt class="py-name">hint</tt><tt class="py-op">)</tt> </tt>
<a name="L1279"></a><tt class="py-lineno">1279</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-112" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-112', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1280"></a><tt class="py-lineno">1280</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_slider_title"></a><div id="get_slider_title-def"><a name="L1281"></a><tt class="py-lineno">1281</tt> <a class="py-toggle" href="#" id="get_slider_title-toggle" onclick="return toggle('get_slider_title');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#get_slider_title">get_slider_title</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_slider_title-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_slider_title-expanded"><a name="L1282"></a><tt class="py-lineno">1282</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L1283"></a><tt class="py-lineno">1283</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1284"></a><tt class="py-lineno">1284</tt>  <tt class="py-line"><tt class="py-docstring">    Retrieves the current title displayed on the main slider. </tt> </tt>
<a name="L1285"></a><tt class="py-lineno">1285</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1286"></a><tt class="py-lineno">1286</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L1287"></a><tt class="py-lineno">1287</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L1288"></a><tt class="py-lineno">1288</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1289"></a><tt class="py-lineno">1289</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L1290"></a><tt class="py-lineno">1290</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L1291"></a><tt class="py-lineno">1291</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1292"></a><tt class="py-lineno">1292</tt>  <tt class="py-line"><tt class="py-docstring">    title </tt> </tt>
<a name="L1293"></a><tt class="py-lineno">1293</tt>  <tt class="py-line"><tt class="py-docstring">    This is a string value containing the full title.</tt> </tt>
<a name="L1294"></a><tt class="py-lineno">1294</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1295"></a><tt class="py-lineno">1295</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L1296"></a><tt class="py-lineno">1296</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-113" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-113', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.app.slider.title"</tt><tt class="py-op">)</tt> </tt>
<a name="L1297"></a><tt class="py-lineno">1297</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-114" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-114', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-115" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-115', '_convert_str_to_type', 'link-45');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1298"></a><tt class="py-lineno">1298</tt>  <tt class="py-line"> </tt>
<a name="set_slider_title"></a><div id="set_slider_title-def"><a name="L1299"></a><tt class="py-lineno">1299</tt> <a class="py-toggle" href="#" id="set_slider_title-toggle" onclick="return toggle('set_slider_title');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#set_slider_title">set_slider_title</a><tt class="py-op">(</tt><tt class="py-param">title</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_slider_title-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_slider_title-expanded"><a name="L1300"></a><tt class="py-lineno">1300</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L1301"></a><tt class="py-lineno">1301</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1302"></a><tt class="py-lineno">1302</tt>  <tt class="py-line"><tt class="py-docstring">    Sets the title to be displayed on the main slider. </tt> </tt>
<a name="L1303"></a><tt class="py-lineno">1303</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1304"></a><tt class="py-lineno">1304</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L1305"></a><tt class="py-lineno">1305</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L1306"></a><tt class="py-lineno">1306</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1307"></a><tt class="py-lineno">1307</tt>  <tt class="py-line"><tt class="py-docstring">    title </tt> </tt>
<a name="L1308"></a><tt class="py-lineno">1308</tt>  <tt class="py-line"><tt class="py-docstring">    This is a string value containing the full title.</tt> </tt>
<a name="L1309"></a><tt class="py-lineno">1309</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1310"></a><tt class="py-lineno">1310</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L1311"></a><tt class="py-lineno">1311</tt>  <tt class="py-line">     </tt>
<a name="L1312"></a><tt class="py-lineno">1312</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-116" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-116', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-117" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-117', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.app.slider.title"</tt><tt class="py-op">,</tt>  </tt>
<a name="L1313"></a><tt class="py-lineno">1313</tt>  <tt class="py-line">                                                  <tt class="py-name">title</tt><tt class="py-op">)</tt> </tt>
<a name="L1314"></a><tt class="py-lineno">1314</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-118" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-118', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1315"></a><tt class="py-lineno">1315</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_username"></a><div id="get_username-def"><a name="L1316"></a><tt class="py-lineno">1316</tt> <a class="py-toggle" href="#" id="get_username-toggle" onclick="return toggle('get_username');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#get_username">get_username</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_username-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_username-expanded"><a name="L1317"></a><tt class="py-lineno">1317</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L1318"></a><tt class="py-lineno">1318</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1319"></a><tt class="py-lineno">1319</tt>  <tt class="py-line"><tt class="py-docstring">    Returns the login name of the currently logged in user on the computer </tt> </tt>
<a name="L1320"></a><tt class="py-lineno">1320</tt>  <tt class="py-line"><tt class="py-docstring">    running ECOTECT. </tt> </tt>
<a name="L1321"></a><tt class="py-lineno">1321</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1322"></a><tt class="py-lineno">1322</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L1323"></a><tt class="py-lineno">1323</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L1324"></a><tt class="py-lineno">1324</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1325"></a><tt class="py-lineno">1325</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L1326"></a><tt class="py-lineno">1326</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L1327"></a><tt class="py-lineno">1327</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1328"></a><tt class="py-lineno">1328</tt>  <tt class="py-line"><tt class="py-docstring">    name </tt> </tt>
<a name="L1329"></a><tt class="py-lineno">1329</tt>  <tt class="py-line"><tt class="py-docstring">    A string value containing the user's login name.</tt> </tt>
<a name="L1330"></a><tt class="py-lineno">1330</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1331"></a><tt class="py-lineno">1331</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L1332"></a><tt class="py-lineno">1332</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-119" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-119', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.app.username"</tt><tt class="py-op">)</tt> </tt>
<a name="L1333"></a><tt class="py-lineno">1333</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-120" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-120', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-121" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-121', '_convert_str_to_type', 'link-45');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1334"></a><tt class="py-lineno">1334</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_web_file"></a><div id="get_web_file-def"><a name="L1335"></a><tt class="py-lineno">1335</tt> <a class="py-toggle" href="#" id="get_web_file-toggle" onclick="return toggle('get_web_file');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#get_web_file">get_web_file</a><tt class="py-op">(</tt><tt class="py-param">url</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_web_file-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_web_file-expanded"><a name="L1336"></a><tt class="py-lineno">1336</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L1337"></a><tt class="py-lineno">1337</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1338"></a><tt class="py-lineno">1338</tt>  <tt class="py-line"><tt class="py-docstring">    Retrieve the contents of the specified web URL from the internet and </tt> </tt>
<a name="L1339"></a><tt class="py-lineno">1339</tt>  <tt class="py-line"><tt class="py-docstring">    stores it as a temporary file on your local hard disk. You must be </tt> </tt>
<a name="L1340"></a><tt class="py-lineno">1340</tt>  <tt class="py-line"><tt class="py-docstring">    responsible for cleaning up these files using the remove() command or </tt> </tt>
<a name="L1341"></a><tt class="py-lineno">1341</tt>  <tt class="py-line"><tt class="py-docstring">    manually using the Tools &gt;: Clear Temporary File... menu item. </tt> </tt>
<a name="L1342"></a><tt class="py-lineno">1342</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1343"></a><tt class="py-lineno">1343</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L1344"></a><tt class="py-lineno">1344</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L1345"></a><tt class="py-lineno">1345</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1346"></a><tt class="py-lineno">1346</tt>  <tt class="py-line"><tt class="py-docstring">    url </tt> </tt>
<a name="L1347"></a><tt class="py-lineno">1347</tt>  <tt class="py-line"><tt class="py-docstring">    The full Universal Resource Locator (URL) of the web page or CGI script </tt> </tt>
<a name="L1348"></a><tt class="py-lineno">1348</tt>  <tt class="py-line"><tt class="py-docstring">    you want to retrieve. If you need to send parameters, use the standard </tt> </tt>
<a name="L1349"></a><tt class="py-lineno">1349</tt>  <tt class="py-line"><tt class="py-docstring">    'url?key1=value1&amp;key2=value2' format. </tt> </tt>
<a name="L1350"></a><tt class="py-lineno">1350</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1351"></a><tt class="py-lineno">1351</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L1352"></a><tt class="py-lineno">1352</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L1353"></a><tt class="py-lineno">1353</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1354"></a><tt class="py-lineno">1354</tt>  <tt class="py-line"><tt class="py-docstring">    tmpfile </tt> </tt>
<a name="L1355"></a><tt class="py-lineno">1355</tt>  <tt class="py-line"><tt class="py-docstring">    The full pathname of the temporary file used to store the downloaded </tt> </tt>
<a name="L1356"></a><tt class="py-lineno">1356</tt>  <tt class="py-line"><tt class="py-docstring">    contents. The script will return an error if the download failes.</tt> </tt>
<a name="L1357"></a><tt class="py-lineno">1357</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1358"></a><tt class="py-lineno">1358</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L1359"></a><tt class="py-lineno">1359</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-122" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-122', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-123" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-123', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.app.web.file"</tt><tt class="py-op">,</tt> <tt class="py-name">url</tt><tt class="py-op">)</tt> </tt>
<a name="L1360"></a><tt class="py-lineno">1360</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-124" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-124', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L1361"></a><tt class="py-lineno">1361</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-125" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-125', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-126" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-126', '_convert_str_to_type', 'link-45');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1362"></a><tt class="py-lineno">1362</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_web_line"></a><div id="get_web_line-def"><a name="L1363"></a><tt class="py-lineno">1363</tt> <a class="py-toggle" href="#" id="get_web_line-toggle" onclick="return toggle('get_web_line');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#get_web_line">get_web_line</a><tt class="py-op">(</tt><tt class="py-param">lineNumber</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_web_line-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_web_line-expanded"><a name="L1364"></a><tt class="py-lineno">1364</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L1365"></a><tt class="py-lineno">1365</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1366"></a><tt class="py-lineno">1366</tt>  <tt class="py-line"><tt class="py-docstring">    Retrieve individual lines of text from the last call to </tt> </tt>
<a name="L1367"></a><tt class="py-lineno">1367</tt>  <tt class="py-line"><tt class="py-docstring">    get.web.page.text. There is obviously a limit to the amount of text you </tt> </tt>
<a name="L1368"></a><tt class="py-lineno">1368</tt>  <tt class="py-line"><tt class="py-docstring">    can transfer, so it is usually safest to retrieve web text line-by-line. </tt> </tt>
<a name="L1369"></a><tt class="py-lineno">1369</tt>  <tt class="py-line"><tt class="py-docstring">    However, if you know the that returned text will be relatively small, </tt> </tt>
<a name="L1370"></a><tt class="py-lineno">1370</tt>  <tt class="py-line"><tt class="py-docstring">    you can use a line number of -1 to retrieve all the text at once. </tt> </tt>
<a name="L1371"></a><tt class="py-lineno">1371</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1372"></a><tt class="py-lineno">1372</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L1373"></a><tt class="py-lineno">1373</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L1374"></a><tt class="py-lineno">1374</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1375"></a><tt class="py-lineno">1375</tt>  <tt class="py-line"><tt class="py-docstring">    lineNumber </tt> </tt>
<a name="L1376"></a><tt class="py-lineno">1376</tt>  <tt class="py-line"><tt class="py-docstring">    The line number to retrieve. You can get the number of lines using </tt> </tt>
<a name="L1377"></a><tt class="py-lineno">1377</tt>  <tt class="py-line"><tt class="py-docstring">    get.web.lines, the raw text results will have </tt> </tt>
<a name="L1378"></a><tt class="py-lineno">1378</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1379"></a><tt class="py-lineno">1379</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L1380"></a><tt class="py-lineno">1380</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L1381"></a><tt class="py-lineno">1381</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1382"></a><tt class="py-lineno">1382</tt>  <tt class="py-line"><tt class="py-docstring">    value </tt> </tt>
<a name="L1383"></a><tt class="py-lineno">1383</tt>  <tt class="py-line"><tt class="py-docstring">    A text string containing the value, if any, associated with the given </tt> </tt>
<a name="L1384"></a><tt class="py-lineno">1384</tt>  <tt class="py-line"><tt class="py-docstring">    key.</tt> </tt>
<a name="L1385"></a><tt class="py-lineno">1385</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1386"></a><tt class="py-lineno">1386</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L1387"></a><tt class="py-lineno">1387</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-127" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-127', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-128" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-128', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.app.web.line"</tt><tt class="py-op">,</tt>  </tt>
<a name="L1388"></a><tt class="py-lineno">1388</tt>  <tt class="py-line">                                                  <tt class="py-name">lineNumber</tt><tt class="py-op">)</tt> </tt>
<a name="L1389"></a><tt class="py-lineno">1389</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-129" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-129', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L1390"></a><tt class="py-lineno">1390</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-130" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-130', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-131" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-131', '_convert_str_to_type', 'link-45');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1391"></a><tt class="py-lineno">1391</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="set_web_login"></a><div id="set_web_login-def"><a name="L1392"></a><tt class="py-lineno">1392</tt> <a class="py-toggle" href="#" id="set_web_login-toggle" onclick="return toggle('set_web_login');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#set_web_login">set_web_login</a><tt class="py-op">(</tt><tt class="py-param">username</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">password</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_web_login-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_web_login-expanded"><a name="L1393"></a><tt class="py-lineno">1393</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L1394"></a><tt class="py-lineno">1394</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1395"></a><tt class="py-lineno">1395</tt>  <tt class="py-line"><tt class="py-docstring">    Many websites require a login name and password in order to authenticate </tt> </tt>
<a name="L1396"></a><tt class="py-lineno">1396</tt>  <tt class="py-line"><tt class="py-docstring">    individual users. Use this property before you request your page to set </tt> </tt>
<a name="L1397"></a><tt class="py-lineno">1397</tt>  <tt class="py-line"><tt class="py-docstring">    both of these. You should consider using the getUserInput() function </tt> </tt>
<a name="L1398"></a><tt class="py-lineno">1398</tt>  <tt class="py-line"><tt class="py-docstring">    rather than hard-coding passwords within your scripts.</tt> </tt>
<a name="L1399"></a><tt class="py-lineno">1399</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1400"></a><tt class="py-lineno">1400</tt>  <tt class="py-line"><tt class="py-docstring">    To clear a previously set username and password, call this property with </tt> </tt>
<a name="L1401"></a><tt class="py-lineno">1401</tt>  <tt class="py-line"><tt class="py-docstring">    no parameters. </tt> </tt>
<a name="L1402"></a><tt class="py-lineno">1402</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1403"></a><tt class="py-lineno">1403</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L1404"></a><tt class="py-lineno">1404</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L1405"></a><tt class="py-lineno">1405</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1406"></a><tt class="py-lineno">1406</tt>  <tt class="py-line"><tt class="py-docstring">    [username] </tt> </tt>
<a name="L1407"></a><tt class="py-lineno">1407</tt>  <tt class="py-line"><tt class="py-docstring">    The user name you require to login.</tt> </tt>
<a name="L1408"></a><tt class="py-lineno">1408</tt>  <tt class="py-line"><tt class="py-docstring">     </tt> </tt>
<a name="L1409"></a><tt class="py-lineno">1409</tt>  <tt class="py-line"><tt class="py-docstring">    [password] </tt> </tt>
<a name="L1410"></a><tt class="py-lineno">1410</tt>  <tt class="py-line"><tt class="py-docstring">    The password you require to login.</tt> </tt>
<a name="L1411"></a><tt class="py-lineno">1411</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1412"></a><tt class="py-lineno">1412</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L1413"></a><tt class="py-lineno">1413</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-132" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-132', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-133" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-133', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.app.web.login"</tt><tt class="py-op">,</tt>  </tt>
<a name="L1414"></a><tt class="py-lineno">1414</tt>  <tt class="py-line">                                                  <tt class="py-name">username</tt><tt class="py-op">,</tt> <tt class="py-name">password</tt><tt class="py-op">)</tt> </tt>
<a name="L1415"></a><tt class="py-lineno">1415</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-134" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-134', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1416"></a><tt class="py-lineno">1416</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_web_page"></a><div id="get_web_page-def"><a name="L1417"></a><tt class="py-lineno">1417</tt> <a class="py-toggle" href="#" id="get_web_page-toggle" onclick="return toggle('get_web_page');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#get_web_page">get_web_page</a><tt class="py-op">(</tt><tt class="py-param">url</tt><tt class="py-op">,</tt> <tt class="py-param">text</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_web_page-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_web_page-expanded"><a name="L1418"></a><tt class="py-lineno">1418</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L1419"></a><tt class="py-lineno">1419</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1420"></a><tt class="py-lineno">1420</tt>  <tt class="py-line"><tt class="py-docstring">    Retrieve the contents of the specified web URL from the internet if you </tt> </tt>
<a name="L1421"></a><tt class="py-lineno">1421</tt>  <tt class="py-line"><tt class="py-docstring">    have access. As many web-based CGI scripts return a series of parameters </tt> </tt>
<a name="L1422"></a><tt class="py-lineno">1422</tt>  <tt class="py-line"><tt class="py-docstring">    in the form 'key=value', by default the downloaded results are parsed </tt> </tt>
<a name="L1423"></a><tt class="py-lineno">1423</tt>  <tt class="py-line"><tt class="py-docstring">    into a series of parameter pairs and can be accessed using the </tt> </tt>
<a name="L1424"></a><tt class="py-lineno">1424</tt>  <tt class="py-line"><tt class="py-docstring">    get.web.param property. If the url you are accessing returns normal text </tt> </tt>
<a name="L1425"></a><tt class="py-lineno">1425</tt>  <tt class="py-line"><tt class="py-docstring">    or some other data format, append the suffix '.text' to avoid the </tt> </tt>
<a name="L1426"></a><tt class="py-lineno">1426</tt>  <tt class="py-line"><tt class="py-docstring">    parsing process and access the data using the get.web.line properties. </tt> </tt>
<a name="L1427"></a><tt class="py-lineno">1427</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1428"></a><tt class="py-lineno">1428</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L1429"></a><tt class="py-lineno">1429</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L1430"></a><tt class="py-lineno">1430</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1431"></a><tt class="py-lineno">1431</tt>  <tt class="py-line"><tt class="py-docstring">    url </tt> </tt>
<a name="L1432"></a><tt class="py-lineno">1432</tt>  <tt class="py-line"><tt class="py-docstring">    The full Universal Resource Locator (URL) of the web page or CGI script </tt> </tt>
<a name="L1433"></a><tt class="py-lineno">1433</tt>  <tt class="py-line"><tt class="py-docstring">    you want to retrieve. If you need to send parameters, use the standard </tt> </tt>
<a name="L1434"></a><tt class="py-lineno">1434</tt>  <tt class="py-line"><tt class="py-docstring">    'url?key1=value1&amp;key2=value2' format.</tt> </tt>
<a name="L1435"></a><tt class="py-lineno">1435</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1436"></a><tt class="py-lineno">1436</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L1437"></a><tt class="py-lineno">1437</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L1438"></a><tt class="py-lineno">1438</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1439"></a><tt class="py-lineno">1439</tt>  <tt class="py-line"><tt class="py-docstring">    result </tt> </tt>
<a name="L1440"></a><tt class="py-lineno">1440</tt>  <tt class="py-line"><tt class="py-docstring">    The number of parameters parsed or, if just text, the number lines </tt> </tt>
<a name="L1441"></a><tt class="py-lineno">1441</tt>  <tt class="py-line"><tt class="py-docstring">    downloaded from the web. For success, this value must be at least 1.</tt> </tt>
<a name="L1442"></a><tt class="py-lineno">1442</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1443"></a><tt class="py-lineno">1443</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L1444"></a><tt class="py-lineno">1444</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-name">text</tt><tt class="py-op">:</tt> </tt>
<a name="L1445"></a><tt class="py-lineno">1445</tt>  <tt class="py-line">        <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-135" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-135', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-136" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-136', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.app.web.page.text"</tt><tt class="py-op">,</tt>  </tt>
<a name="L1446"></a><tt class="py-lineno">1446</tt>  <tt class="py-line">                                                      <tt class="py-name">url</tt><tt class="py-op">)</tt> </tt>
<a name="L1447"></a><tt class="py-lineno">1447</tt>  <tt class="py-line">    <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L1448"></a><tt class="py-lineno">1448</tt>  <tt class="py-line">        <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-137" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-137', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-138" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-138', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.app.web.page"</tt><tt class="py-op">,</tt>  </tt>
<a name="L1449"></a><tt class="py-lineno">1449</tt>  <tt class="py-line">                                                      <tt class="py-name">url</tt><tt class="py-op">)</tt> </tt>
<a name="L1450"></a><tt class="py-lineno">1450</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-139" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-139', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L1451"></a><tt class="py-lineno">1451</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-140" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-140', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-141" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-141', '_convert_str_to_type', 'link-45');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1452"></a><tt class="py-lineno">1452</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_web_param"></a><div id="get_web_param-def"><a name="L1453"></a><tt class="py-lineno">1453</tt> <a class="py-toggle" href="#" id="get_web_param-toggle" onclick="return toggle('get_web_param');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#get_web_param">get_web_param</a><tt class="py-op">(</tt><tt class="py-param">name</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">index</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_web_param-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_web_param-expanded"><a name="L1454"></a><tt class="py-lineno">1454</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L1455"></a><tt class="py-lineno">1455</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1456"></a><tt class="py-lineno">1456</tt>  <tt class="py-line"><tt class="py-docstring">    Many web-based CGI scripts return a series of parameters in the form </tt> </tt>
<a name="L1457"></a><tt class="py-lineno">1457</tt>  <tt class="py-line"><tt class="py-docstring">    'key=value'. After you have used the get.web.page property, use this to </tt> </tt>
<a name="L1458"></a><tt class="py-lineno">1458</tt>  <tt class="py-line"><tt class="py-docstring">    retrieve any value associated with a particular key. </tt> </tt>
<a name="L1459"></a><tt class="py-lineno">1459</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1460"></a><tt class="py-lineno">1460</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L1461"></a><tt class="py-lineno">1461</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L1462"></a><tt class="py-lineno">1462</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1463"></a><tt class="py-lineno">1463</tt>  <tt class="py-line"><tt class="py-docstring">    name </tt> </tt>
<a name="L1464"></a><tt class="py-lineno">1464</tt>  <tt class="py-line"><tt class="py-docstring">    The name of the key returned by the web-based CGI script.</tt> </tt>
<a name="L1465"></a><tt class="py-lineno">1465</tt>  <tt class="py-line"><tt class="py-docstring">     </tt> </tt>
<a name="L1466"></a><tt class="py-lineno">1466</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L1467"></a><tt class="py-lineno">1467</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L1468"></a><tt class="py-lineno">1468</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1469"></a><tt class="py-lineno">1469</tt>  <tt class="py-line"><tt class="py-docstring">    value </tt> </tt>
<a name="L1470"></a><tt class="py-lineno">1470</tt>  <tt class="py-line"><tt class="py-docstring">    A text string containing the value, if any, associated with the given </tt> </tt>
<a name="L1471"></a><tt class="py-lineno">1471</tt>  <tt class="py-line"><tt class="py-docstring">    key. </tt> </tt>
<a name="L1472"></a><tt class="py-lineno">1472</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1473"></a><tt class="py-lineno">1473</tt>  <tt class="py-line"><tt class="py-docstring">    Many web-based CGI scripts return a series of parameters in the form </tt> </tt>
<a name="L1474"></a><tt class="py-lineno">1474</tt>  <tt class="py-line"><tt class="py-docstring">    'key=value'. If you don't know the names of all the keys, you can use </tt> </tt>
<a name="L1475"></a><tt class="py-lineno">1475</tt>  <tt class="py-line"><tt class="py-docstring">    the index of each one to retrieve them. You can only do this after you </tt> </tt>
<a name="L1476"></a><tt class="py-lineno">1476</tt>  <tt class="py-line"><tt class="py-docstring">    have used the get.web.page property and stored the number of parameters </tt> </tt>
<a name="L1477"></a><tt class="py-lineno">1477</tt>  <tt class="py-line"><tt class="py-docstring">    parsed. </tt> </tt>
<a name="L1478"></a><tt class="py-lineno">1478</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1479"></a><tt class="py-lineno">1479</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L1480"></a><tt class="py-lineno">1480</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L1481"></a><tt class="py-lineno">1481</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1482"></a><tt class="py-lineno">1482</tt>  <tt class="py-line"><tt class="py-docstring">    index </tt> </tt>
<a name="L1483"></a><tt class="py-lineno">1483</tt>  <tt class="py-line"><tt class="py-docstring">    The integer index of key=value pair to retrieve.</tt> </tt>
<a name="L1484"></a><tt class="py-lineno">1484</tt>  <tt class="py-line"><tt class="py-docstring">     </tt> </tt>
<a name="L1485"></a><tt class="py-lineno">1485</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L1486"></a><tt class="py-lineno">1486</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L1487"></a><tt class="py-lineno">1487</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1488"></a><tt class="py-lineno">1488</tt>  <tt class="py-line"><tt class="py-docstring">    key </tt> </tt>
<a name="L1489"></a><tt class="py-lineno">1489</tt>  <tt class="py-line"><tt class="py-docstring">    A text string containing the key name.</tt> </tt>
<a name="L1490"></a><tt class="py-lineno">1490</tt>  <tt class="py-line"><tt class="py-docstring">     </tt> </tt>
<a name="L1491"></a><tt class="py-lineno">1491</tt>  <tt class="py-line"><tt class="py-docstring">    value </tt> </tt>
<a name="L1492"></a><tt class="py-lineno">1492</tt>  <tt class="py-line"><tt class="py-docstring">    A text string containing the value, if any, associated with that key. </tt> </tt>
<a name="L1493"></a><tt class="py-lineno">1493</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1494"></a><tt class="py-lineno">1494</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L1495"></a><tt class="py-lineno">1495</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt id="link-142" class="py-name"><a title="py2ecotect.ent.zone.Zone.name" class="py-name" href="#" onclick="return doclink('link-142', 'name', 'link-49');">name</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1496"></a><tt class="py-lineno">1496</tt>  <tt class="py-line">        <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-143" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-143', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-144" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-144', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.app.web.param"</tt><tt class="py-op">,</tt>  </tt>
<a name="L1497"></a><tt class="py-lineno">1497</tt>  <tt class="py-line">                                                      <tt id="link-145" class="py-name"><a title="py2ecotect.ent.zone.Zone.name" class="py-name" href="#" onclick="return doclink('link-145', 'name', 'link-49');">name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1498"></a><tt class="py-lineno">1498</tt>  <tt class="py-line">        <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-146" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-146', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L1499"></a><tt class="py-lineno">1499</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-147" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-147', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-148" class="py-name"><a title="py2ecotect._util._convert_str_to_type" class="py-name" href="#" onclick="return doclink('link-148', '_convert_str_to_type', 'link-45');">_convert_str_to_type</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
<a name="L1500"></a><tt class="py-lineno">1500</tt>  <tt class="py-line">    <tt class="py-keyword">elif</tt> <tt id="link-149" class="py-name"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-149', 'index', 'link-55');">index</a></tt><tt class="py-op">:</tt> </tt>
<a name="L1501"></a><tt class="py-lineno">1501</tt>  <tt class="py-line">        <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-150" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-150', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-151" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-151', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"get.app.web.param.index"</tt><tt class="py-op">,</tt>  </tt>
<a name="L1502"></a><tt class="py-lineno">1502</tt>  <tt class="py-line">                                                     <tt id="link-152" class="py-name"><a title="py2ecotect.doc.select.Select.index" class="py-name" href="#" onclick="return doclink('link-152', 'index', 'link-55');">index</a></tt><tt class="py-op">)</tt> </tt>
<a name="L1503"></a><tt class="py-lineno">1503</tt>  <tt class="py-line">        <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-153" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-153', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
<a name="L1504"></a><tt class="py-lineno">1504</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-154" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-154', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-155" class="py-name"><a title="py2ecotect._util._convert_str_to_list" class="py-name" href="#" onclick="return doclink('link-155', '_convert_str_to_list', 'link-58');">_convert_str_to_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1505"></a><tt class="py-lineno">1505</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------ </tt> </tt>
<a name="get_window"></a><div id="get_window-def"><a name="L1506"></a><tt class="py-lineno">1506</tt> <a class="py-toggle" href="#" id="get_window-toggle" onclick="return toggle('get_window');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#get_window">get_window</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_window-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="get_window-expanded"><a name="L1507"></a><tt class="py-lineno">1507</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L1508"></a><tt class="py-lineno">1508</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1509"></a><tt class="py-lineno">1509</tt>  <tt class="py-line"><tt class="py-docstring">    Retrieve the position and size of the main ECOTECT window displayed </tt> </tt>
<a name="L1510"></a><tt class="py-lineno">1510</tt>  <tt class="py-line"><tt class="py-docstring">    within your screen. </tt> </tt>
<a name="L1511"></a><tt class="py-lineno">1511</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1512"></a><tt class="py-lineno">1512</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L1513"></a><tt class="py-lineno">1513</tt>  <tt class="py-line"><tt class="py-docstring">    There are no parameters for this property.</tt> </tt>
<a name="L1514"></a><tt class="py-lineno">1514</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1515"></a><tt class="py-lineno">1515</tt>  <tt class="py-line"><tt class="py-docstring">    Return Value(s)</tt> </tt>
<a name="L1516"></a><tt class="py-lineno">1516</tt>  <tt class="py-line"><tt class="py-docstring">    Getting this property returns the following value(s).</tt> </tt>
<a name="L1517"></a><tt class="py-lineno">1517</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1518"></a><tt class="py-lineno">1518</tt>  <tt class="py-line"><tt class="py-docstring">    left </tt> </tt>
<a name="L1519"></a><tt class="py-lineno">1519</tt>  <tt class="py-line"><tt class="py-docstring">    The position of the left side of the window in screen pixels. </tt> </tt>
<a name="L1520"></a><tt class="py-lineno">1520</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1521"></a><tt class="py-lineno">1521</tt>  <tt class="py-line"><tt class="py-docstring">    top </tt> </tt>
<a name="L1522"></a><tt class="py-lineno">1522</tt>  <tt class="py-line"><tt class="py-docstring">    The position of the top side of the window in screen pixels. </tt> </tt>
<a name="L1523"></a><tt class="py-lineno">1523</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1524"></a><tt class="py-lineno">1524</tt>  <tt class="py-line"><tt class="py-docstring">    width </tt> </tt>
<a name="L1525"></a><tt class="py-lineno">1525</tt>  <tt class="py-line"><tt class="py-docstring">    The horizontal width of the window in screen pixels. </tt> </tt>
<a name="L1526"></a><tt class="py-lineno">1526</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1527"></a><tt class="py-lineno">1527</tt>  <tt class="py-line"><tt class="py-docstring">    height </tt> </tt>
<a name="L1528"></a><tt class="py-lineno">1528</tt>  <tt class="py-line"><tt class="py-docstring">    The vertical height of the window in screen pixels.</tt> </tt>
<a name="L1529"></a><tt class="py-lineno">1529</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1530"></a><tt class="py-lineno">1530</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L1531"></a><tt class="py-lineno">1531</tt>  <tt class="py-line">    <tt class="py-name">val</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-156" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-156', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Request</tt><tt class="py-op">(</tt><tt class="py-string">"get.app.window"</tt><tt class="py-op">)</tt> </tt>
<a name="L1532"></a><tt class="py-lineno">1532</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-157" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-157', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-158" class="py-name"><a title="py2ecotect._util._convert_str_to_list" class="py-name" href="#" onclick="return doclink('link-158', '_convert_str_to_list', 'link-58');">_convert_str_to_list</a></tt><tt class="py-op">(</tt><tt class="py-name">val</tt><tt class="py-op">,</tt> <tt class="py-name">int</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1533"></a><tt class="py-lineno">1533</tt>  <tt class="py-line"> </tt>
<a name="set_window"></a><div id="set_window-def"><a name="L1534"></a><tt class="py-lineno">1534</tt> <a class="py-toggle" href="#" id="set_window-toggle" onclick="return toggle('set_window');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="py2ecotect.app.application-module.html#set_window">set_window</a><tt class="py-op">(</tt><tt class="py-param">left</tt><tt class="py-op">,</tt> <tt class="py-param">top</tt><tt class="py-op">,</tt> <tt class="py-param">width</tt><tt class="py-op">,</tt> <tt class="py-param">height</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="set_window-collapsed" style="display:none;" pad="++++" indent="++++"></div><div id="set_window-expanded"><a name="L1535"></a><tt class="py-lineno">1535</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L1536"></a><tt class="py-lineno">1536</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1537"></a><tt class="py-lineno">1537</tt>  <tt class="py-line"><tt class="py-docstring">    Sets the position and size of the main ECOTECT window displayed within </tt> </tt>
<a name="L1538"></a><tt class="py-lineno">1538</tt>  <tt class="py-line"><tt class="py-docstring">    your screen. </tt> </tt>
<a name="L1539"></a><tt class="py-lineno">1539</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L1540"></a><tt class="py-lineno">1540</tt>  <tt class="py-line"><tt class="py-docstring">    Parameter(s)</tt> </tt>
<a name="L1541"></a><tt class="py-lineno">1541</tt>  <tt class="py-line"><tt class="py-docstring">    This property takes the following parameters.</tt> </tt>
<a name="L1542"></a><tt class="py-lineno">1542</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1543"></a><tt class="py-lineno">1543</tt>  <tt class="py-line"><tt class="py-docstring">    left </tt> </tt>
<a name="L1544"></a><tt class="py-lineno">1544</tt>  <tt class="py-line"><tt class="py-docstring">    The position of the left side of the window in screen pixels. If this </tt> </tt>
<a name="L1545"></a><tt class="py-lineno">1545</tt>  <tt class="py-line"><tt class="py-docstring">    value is less than zero, the left side of the window will not be </tt> </tt>
<a name="L1546"></a><tt class="py-lineno">1546</tt>  <tt class="py-line"><tt class="py-docstring">    changed. </tt> </tt>
<a name="L1547"></a><tt class="py-lineno">1547</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1548"></a><tt class="py-lineno">1548</tt>  <tt class="py-line"><tt class="py-docstring">    top </tt> </tt>
<a name="L1549"></a><tt class="py-lineno">1549</tt>  <tt class="py-line"><tt class="py-docstring">    The position of the top side of the window in screen pixels. If this </tt> </tt>
<a name="L1550"></a><tt class="py-lineno">1550</tt>  <tt class="py-line"><tt class="py-docstring">    value is less than zero, the top of the window will not be changed. </tt> </tt>
<a name="L1551"></a><tt class="py-lineno">1551</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1552"></a><tt class="py-lineno">1552</tt>  <tt class="py-line"><tt class="py-docstring">    width </tt> </tt>
<a name="L1553"></a><tt class="py-lineno">1553</tt>  <tt class="py-line"><tt class="py-docstring">    The horizontal width of the window in screen pixels. This parameter is </tt> </tt>
<a name="L1554"></a><tt class="py-lineno">1554</tt>  <tt class="py-line"><tt class="py-docstring">    optional - if not given or less than zero the width of the window will </tt> </tt>
<a name="L1555"></a><tt class="py-lineno">1555</tt>  <tt class="py-line"><tt class="py-docstring">    not be changed. </tt> </tt>
<a name="L1556"></a><tt class="py-lineno">1556</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1557"></a><tt class="py-lineno">1557</tt>  <tt class="py-line"><tt class="py-docstring">    height </tt> </tt>
<a name="L1558"></a><tt class="py-lineno">1558</tt>  <tt class="py-line"><tt class="py-docstring">    The vertical height of the window in screen pixels. This parameter is </tt> </tt>
<a name="L1559"></a><tt class="py-lineno">1559</tt>  <tt class="py-line"><tt class="py-docstring">    optional - if not given or less than zero the height of the window will </tt> </tt>
<a name="L1560"></a><tt class="py-lineno">1560</tt>  <tt class="py-line"><tt class="py-docstring">    not be changed.</tt> </tt>
<a name="L1561"></a><tt class="py-lineno">1561</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L1562"></a><tt class="py-lineno">1562</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L1563"></a><tt class="py-lineno">1563</tt>  <tt class="py-line">    <tt class="py-name">arg_str</tt> <tt class="py-op">=</tt> <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-159" class="py-name"><a title="py2ecotect._util" class="py-name" href="#" onclick="return doclink('link-159', '_util', 'link-2');">_util</a></tt><tt class="py-op">.</tt><tt id="link-160" class="py-name"><a title="py2ecotect._util._convert_args_to_string" class="py-name" href="#" onclick="return doclink('link-160', '_convert_args_to_string', 'link-3');">_convert_args_to_string</a></tt><tt class="py-op">(</tt><tt class="py-string">"set.app.window"</tt><tt class="py-op">,</tt> <tt class="py-name">left</tt><tt class="py-op">,</tt>  </tt>
<a name="L1564"></a><tt class="py-lineno">1564</tt>  <tt class="py-line">                                                 <tt class="py-name">top</tt><tt class="py-op">,</tt>  </tt>
<a name="L1565"></a><tt class="py-lineno">1565</tt>  <tt class="py-line">                                                 <tt class="py-name">width</tt><tt class="py-op">,</tt>  </tt>
<a name="L1566"></a><tt class="py-lineno">1566</tt>  <tt class="py-line">                                                 <tt class="py-name">height</tt><tt class="py-op">)</tt> </tt>
<a name="L1567"></a><tt class="py-lineno">1567</tt>  <tt class="py-line">    <tt class="py-name">p2e</tt><tt class="py-op">.</tt><tt id="link-161" class="py-name"><a title="py2ecotect._app" class="py-name" href="#" onclick="return doclink('link-161', '_app', 'link-1');">_app</a></tt><tt class="py-op">.</tt><tt class="py-name">Exec</tt><tt class="py-op">(</tt><tt class="py-name">arg_str</tt><tt class="py-op">)</tt> </tt>
</div><a name="L1568"></a><tt class="py-lineno">1568</tt>  <tt class="py-line"><tt class="py-comment">#------------------------------------------------------------------------------</tt> </tt>
<a name="L1569"></a><tt class="py-lineno">1569</tt>  <tt class="py-line"><tt class="py-comment"></tt> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Aug 28 01:29:49 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
